{"info":{"_postman_id":"c820b874-8908-4201-82b1-ee35eca8c47b","name":"Lead Advantage Pro API","description":"<html><head></head><body><p><strong>NOTE: To use the \"Run in Postman\" option you MUST be using a recent version of the Chrome browser.</strong></p>\n<p>The Lead Advantage Pro API provides low-level access to the actions that powers the Lead Advantage Pro Agent Support Tool. Available features include: Carrier and Plan Forms, Product Quoting, Enrollment Technologies, as well as a suite of lead management and agent CRM tools.</p>\n<p>If you encounter and issue or have questions/suggestions regarding the API, please enter a ticket into our <a href=\"https://leadadvantage.atlassian.net/servicedesk/customer/portal/3/create/18\">Issue Tracking System</a>.</p>\n<h2 id=\"a-note-about-the-conventions-used-in-this-guide\">A note about the conventions used in this guide</h2>\n<p>This guide uses the documentation features of the Postman API testing tool. Portions of the API calls that include variables will be denoted by double curly brackets: {{ }}</p>\n<p>Where feasable, we've provided this guide with a set of sample Postman variables to aid in your implementation and testing. You can toggle the sample variables using the environment drop down at the top of the page. If you already are a Postman user (we highly recommend it), you can replace these sample variable values with your own - this will greatly speed up the implementation process.</p>\n<h2 id=\"api-response-conventions\">API Response conventions</h2>\n<p>In almost all cases, the Lead Advantage API will return results in JSON format.</p>\n<p>In the event that an API call is successful, but results in no results returned (e.g. a valid search that returns zero records), the result format will return a reduced form of the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469181/API+Error+Response+Object\">API Error Response Object</a>:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">// HTTP status code: 200\n{\n  \"result\": \"\",\n  \"message\": \"No results returned.\",\n  \"success\": \"0\"\n}\n\n</code></pre>\n<p>In the event of an actual error, the status code returned by the API will indicate the type of issue encountered</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>Success</td>\n</tr>\n<tr>\n<td>400</td>\n<td>There was a problem with the data provided</td>\n</tr>\n<tr>\n<td>401</td>\n<td>Your Access Token is invalid</td>\n</tr>\n<tr>\n<td>403</td>\n<td>Your account does not have access to the resource</td>\n</tr>\n<tr>\n<td>404</td>\n<td>The resource cannot be found or has been deleted</td>\n</tr>\n<tr>\n<td>405</td>\n<td>The endpoint does not support the HTTP Verb used in the request</td>\n</tr>\n<tr>\n<td>419</td>\n<td>Your Access Token has expired</td>\n</tr>\n<tr>\n<td>500</td>\n<td>The API has encountered an unexpected error</td>\n</tr>\n</tbody>\n</table>\n</div><p>If an API call does result in an error, the Lead Advantage API will return a full version of the standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469181/API+Error+Response+Object\">API Error Response Object</a>.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"54350097","collectionId":"c820b874-8908-4201-82b1-ee35eca8c47b","publishedId":"2sBXqQEHJg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-12T15:36:13.000Z"},"item":[{"name":"Authorization","item":[{"name":"Requesting an Access Token","event":[{"listen":"test","script":{"id":"f53bda13-f9a2-4644-bcb5-8733f6135eff","exec":["","var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AccessToken\", data.access_token);","postman.setEnvironmentVariable(\"RefreshToken\", data.refresh_token);","tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"d2949ee4-0343-4823-b9ad-ad7735adab83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"{{AgentUsername}}","type":"text"},{"key":"password","value":"{{AgentPassword}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"{{APIPartnerClientID}}","type":"text"},{"key":"client_secret","value":"{{APIPartnerClientSecret}}","type":"text"}]},"url":"https://{{BaseAuth}}/access_token","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>username</td>\n<td>string(50)</td>\n<td>HTTP Form</td>\n<td>The username/login of a valid, existing User profile's <code>User Credentials</code> in the Lead Advantage system</td>\n</tr>\n<tr>\n<td>password</td>\n<td>string(150)</td>\n<td>HTTP Form</td>\n<td>The password associated with the User profile's <code>User Credentials</code></td>\n</tr>\n<tr>\n<td>grant_type</td>\n<td>string(10)</td>\n<td>HTTP Form</td>\n<td>This value should always be set to the value: <code>password</code></td>\n</tr>\n<tr>\n<td>client_id</td>\n<td>string</td>\n<td>HTTP Form</td>\n<td>Your API Partner Client ID issued by the Lead Advantage team</td>\n</tr>\n<tr>\n<td>client_secret</td>\n<td>string</td>\n<td>HTTP Form</td>\n<td>Your API Partner Client Secret value issued by the Lead Advantage teams</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338145/Access+Token+Response+Object\">Access Token Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Use the oAuth 2.0 access token endpoint to generate a fresh authorization token for use in the API. You must provide the username and password of a valid, existing user account in order to perform any and all Lead Advantage API actions. You must provide the following fields:</p>\n","urlObject":{"protocol":"https","path":["access_token"],"host":["{{BaseAuth}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2949ee4-0343-4823-b9ad-ad7735adab83"},{"name":"Requesting an Access Token w/Refresh Token","event":[{"listen":"test","script":{"id":"ab101539-6dd6-4b57-adbc-bdd870fe588b","exec":["","var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AccessToken\", data.access_token);","","tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"92c93b59-5d0d-4a1f-92b0-1b8929653db8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"client_id","value":"PASTE_API_PARTNER_CLIENT_ID","type":"text","uuid":"83dd9633-51ca-48b7-97d2-f1665cf2b814"},{"key":"client_secret","value":"PASTE_API_PARTNER_CLIENT_SECRET_HERE","type":"text","uuid":"e3591152-a226-4f1a-ae7e-5b94b9bdbb1d"},{"key":"refresh_token","value":"2a109tU8616JYD4xqETtZEHJOcBWtdBHIxPiKWYvnuUHprZuQa","type":"text"}]},"url":"https://{{BaseAuth}}/refresh_token","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>grant_type</td>\n<td>string(10)</td>\n<td>HTTP Form</td>\n<td>This value should always be set to the value: <code>password</code></td>\n</tr>\n<tr>\n<td>client_id</td>\n<td>string</td>\n<td>HTTP Form</td>\n<td>Your API Partner Client ID issued by the Lead Advantage team</td>\n</tr>\n<tr>\n<td>client_secret</td>\n<td>string</td>\n<td>HTTP Form</td>\n<td>Your API Partner Client Secret value issued by the Lead Advantage teams</td>\n</tr>\n<tr>\n<td>refresh_token</td>\n<td>string</td>\n<td>HTTP Form</td>\n<td>Your current token to be refreshed</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338145/Access+Token+Response+Object\">Access Token Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Use the oAuth 2.0 access token endpoint to generate a fresh authorization token for use in the API. You must provide the username and password of a valid, existing user account in order to perform any and all Lead Advantage API actions. You must provide the following fields:</p>\n","urlObject":{"protocol":"https","path":["refresh_token"],"host":["{{BaseAuth}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"92c93b59-5d0d-4a1f-92b0-1b8929653db8"}],"id":"e739bf78-8166-43cb-8a4f-a09646fbeda7","description":"<p>You must generate a valid access token in order to perform Lead Advantage API calls</p>\n<p>All Lead Advantage API calls require the presence of an <code>Authorization</code> header that includes the access token.  Failure to include the access token will result in a 401 response.</p>\n","_postman_id":"e739bf78-8166-43cb-8a4f-a09646fbeda7"},{"name":"Codes & Enumerations","item":[{"name":"List Supported Address Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"0f8e689e-e29c-470f-b3a7-246ab017695b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{BaseAPI}}/api/address/types","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665803/API+Type+Object\">API Type Object</a></p>\n<p>View all address types currently supported by the Lead Advantage API.</p>\n","urlObject":{"protocol":"https","path":["api","address","types"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f8e689e-e29c-470f-b3a7-246ab017695b"},{"name":"List Supported Document/Form Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"245e9aea-24f5-4c8d-a3ab-e3ccdfd9e894","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{BaseAPI}}/api/document/types","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665803/API+Type+Object\">API Type Object</a></p>\n<p>View all document/form types currently supported by the Lead Advantage API.</p>\n","urlObject":{"protocol":"https","path":["api","document","types"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"245e9aea-24f5-4c8d-a3ab-e3ccdfd9e894"},{"name":"List Supported Email Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"3e025071-e2b4-479f-9927-8ee35b841b0f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{BaseAPI}}/api/email/types","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665803/API+Type+Object\">API Type Object</a></p>\n<p>View all email types currently supported by the Lead Advantage API.</p>\n","urlObject":{"protocol":"https","path":["api","email","types"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e025071-e2b4-479f-9927-8ee35b841b0f"},{"name":"List Supported Lead Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c981ee61-7faf-4107-aeb3-487ada3fc303","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{BaseAPI}}/api/lead/types","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665803/API+Type+Object\">API Type Object</a></p>\n<p>View all Lead types currently supported by the Lead Advantage API.</p>\n","urlObject":{"protocol":"https","path":["api","lead","types"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c981ee61-7faf-4107-aeb3-487ada3fc303"},{"name":"List Supported Phone Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"d58d44b3-9f80-4715-acf1-6af90a6660f9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{BaseAPI}}/api/phone/types","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665803/API+Type+Object\">API Type Object</a></p>\n<p>View all phone types currently supported by the Lead Advantage API.</p>\n","urlObject":{"protocol":"https","path":["api","phone","types"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d58d44b3-9f80-4715-acf1-6af90a6660f9"},{"name":"List Supported Product Types","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"aa7de1ed-623c-4c45-8f5b-147402efaba5","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"search_type\": \"simple\",\n  \"criteria\": \n    {\n      \"product_type_id\":{\n      \"type\":\"range\",\n      \"value\":[\"1\",\"*\"]\n      }\n    },\n  \"field_list\": \"\"\n}\n"},"url":"https://{{BaseAPI}}/api/productType/search","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Product Type Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338175/Product+Search+Result+Objects\">Product Search Result Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>View all product types currently supported by the Lead Advantage API. The body payload of this API request uses the Lead Advantage API standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Product Type fields available for use in searches include:</p>\n<ul>\n<li><p><code>product_type_desc</code></p>\n</li>\n<li><p><code>product_type_id</code></p>\n</li>\n<li><p><code>product_type_name</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","productType","search"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa7de1ed-623c-4c45-8f5b-147402efaba5"}],"id":"c2f08479-ffcf-4cda-9089-50a6c4ceda63","description":"<p>Lead Advantage has a number of code and enumeration values that you will need to use in order to access some of the functionality.  This section lists the endpoints that provide these values.</p>\n","_postman_id":"c2f08479-ffcf-4cda-9089-50a6c4ceda63"},{"name":"Enroll - AICOE","item":[{"name":"01 Preview AICOE Email Message(s)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"12b3ab89-4fdb-4872-b0fd-bf9c567ab382","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"draft\":\"1\",\r\n  \"lead_id\": \"{{SampleLeadID}}\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"user_carrier_id\": \"{{AgentUserCarrierID}}\",\r\n  \"client_name\": \"Bob Cliente\",\r\n  \"client_email\": \"{{SampleLeadEmail}}\",\r\n  \"client_dob\": \"1950-12-01\",\r\n  \"client_zip\": \"22314\",\r\n  \"plan_name\": \"Aetna Medicare Innovation Choice Plan (PPO)\",\r\n  \"plan_id\": \"2017_H5521_027_000\",\r\n  \"health_status\": \"Good\",\r\n  \"process_type\": \"AICOE\",\r\n  \"alert_notice\": \"0\",\r\n  \"alert_email\": \"1\"\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with <code>\"process_type\":\"AICOE\"</code></td>\n<td>HTTP Body</td>\n<td>Identifies the User, Client and Plan to generate an AICOE invitation for</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: Keep track of the</strong> <strong><code>client_invite_id</code></strong> <strong>value generated by this call - you will use it to check for status updates for this AICOE Client Invitation</strong></p>\n<p>Generates an AICOE Client Invitation record in <strong>DRAFT mode</strong> to allow API partners to provide a preview of the AICOE email content to their users</p>\n<p>DRAFT mode generates an AICOE Client Invitation record but suspends the sending of the message until the Client Invite message is updated with the property <code>\"draft\":\"0\"</code>.</p>\n<p>If you wish to generate the AICOE client Invitation and send it to the client in a single step, you can create the AICOE Client Invitation using this same call with the property <code>\"draft\":\"0\"</code>.</p>\n<p><strong>REQUIREMENTS: All Lead Advantage users must have a valid Agent Writing Number on file for the specified carrier in the Lead Advantage system before an AICOE Client Inivtation can be sent.</strong></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12b3ab89-4fdb-4872-b0fd-bf9c567ab382"},{"name":"02 Send AICOE Invitation Message(s)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"8179512d-12fa-457c-ad6d-4fff4960ea40","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"client_invite_id\": \"{{ClientInviteAICOEID}}\",\r\n  \"draft\":\"0\"\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td>Simplified <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></td>\n<td>HTTP Body</td>\n<td>Update an existing AICOE Client invitation by only providing the <code>client_invite_id</code> and <code>\"draft\":\"0\"</code> properties</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Updates am AICOE Client Invitation record that has been saved in <strong>DRAFT mode</strong> and sends the pending Email Message containing the invitation to the client</p>\n<p>Note:</p>\n<ul>\n<li><p>When updating the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> record to send the AICOE Invitation you may reduce the object to only include the <code>draft</code> and <code>client_invite_id</code> properties as seen in the example below.</p>\n</li>\n<li><p>Instructions on how to create an Client Invitation for AICOE in <strong>DRAFT mode</strong> is described in <a href=\"https://apidocs.leadadvantagepro.com/#b15dfa6f-3c3f-5270-7c4a-fc0d58693219\">Step 01</a> of the AICOE process.</p>\n</li>\n<li><p>If you wish to generate the AICOE client Invitation and send it to the client in a single step, you can create the AICOE Client Invitation using this same call with the property <code>\"draft\":\"0\"</code>.</p>\n</li>\n</ul>\n<p><strong>REQUIREMENTS: All Lead Advantage users must have a valid Agent Writing Number on file for the specified carrier in the Lead Advantage system before an AICOE Client Invitation can be sent.</strong></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8179512d-12fa-457c-ad6d-4fff4960ea40"},{"name":"03 Check AICOE Invitation Status","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"fc950430-caf5-46e2-b3e7-efbb1d8b74c9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/{{ClientInviteAICOEID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>client_invite_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifies the AICOE Client Invitation to retrieve client access information for</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieves an updated AICOE Client Invitation record. If a Client has interacted with the invitation, client access date times will be stamped in <code>client_first_visit_date</code> and <code>client_last_visit_date</code> properties of the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite","{{ClientInviteAICOEID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc950430-caf5-46e2-b3e7-efbb1d8b74c9"},{"name":"04 Automating Status Updates via Webhooks","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"e962870a-6329-484b-8db5-fc6091fc8f5e","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"client_invite_id\": \"{{ClientInviteAICOEID}}\",\r\n  \"draft\":\"0\",\r\n  \"notification_address\":\"https://www.example.com/my_postback_receiver\"\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<p>The AICOE process include the option to include updates on AICOE enrollments via an HTTP webhook.  You may provide a URL to a location on your server(s) and the Lead Advantage Pro system will post an HTTP data payload including the details on changes/updates to the enrollment attempt.</p>\n<p>To recieve postback notifications for AICOE application status updates, specify a postback URL in the notification_address field of the client invite request.  </p>\n<p>See <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LPKC/pages/232882177/Receiving+Automatic+Updates+Via+Lead+Advantage+Pro+Webhooks\">Receiving Automatic Updates Via Lead Advantage Pro Webhooks</a></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e962870a-6329-484b-8db5-fc6091fc8f5e"},{"name":"05 Retrieve Submitted AICOE DRX Data (Text)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"1e25d32d-72b2-40f9-b48a-26cb30309e22","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"\r\n"},"url":"https://{{BaseAPI}}/api/lead/{{AICOEDRXleadID}}/app/{{AICOEDRXappID}}/aicoe_data","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Lead id associated with AICOE enrollment</td>\n</tr>\n<tr>\n<td>app_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Enrollment/app_id associated with AICOE enrollment</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: a String containing a comma delimeted series of Name/Value pairs (e.g. \"field1:value1,field2,value2\")</p>\n<p>Retrieves the contents of the AICOE enrollment data as a series of comma-delimeted Name:Value pairs</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{AICOEDRXleadID}}","app","{{AICOEDRXappID}}","aicoe_data"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e25d32d-72b2-40f9-b48a-26cb30309e22"},{"name":"06 Retrieve Submitted AICOE DRX Data (PDF)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"7cc49a66-a584-4ab1-9955-223467b2001b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"\r\n"},"url":"https://{{BaseAPI}}/api/lead/{{AICOEDRXleadID}}/app/{{AICOEDRXappID}}/aicoe_data/pdf","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Lead id associated with AICOE Enrollment</td>\n</tr>\n<tr>\n<td>app_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Enrollment/app_id associated with AICOE enrollment</td>\n</tr>\n<tr>\n<td>Returns: a PDF file containing AICOE enrollment data in tabular format</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Retrieves the contents of the AICOE enrollment data as a PDF (data displayed as Name</td>\n<td>Value tabular format)</td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","lead","{{AICOEDRXleadID}}","app","{{AICOEDRXappID}}","aicoe_data","pdf"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7cc49a66-a584-4ab1-9955-223467b2001b"}],"id":"59d08446-a197-401d-abf4-372a213c18cf","description":"<p>This section lists the endpoints and calls needed to execute the Agent Initiated Consumer Online Enrollment (AICOE) option through the Lead Advantage system.</p>\n","_postman_id":"59d08446-a197-401d-abf4-372a213c18cf"},{"name":"Enroll - App by Email","item":[{"name":"Generate an App By Email Invite URL","id":"81a72c2e-8a12-4281-887d-ff981017d1dc","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"eff_date\": \"07/01/2017\",\r\n  \"return_url\": \"https://www.example.com/postback/\",\r\n  \r\n  \"account_id\": \"11133\",\r\n  \"external_id\": \"3934\",\r\n\r\n  \"plan_id\": \"2016_S5810_068_000\",\r\n  \r\n  \"partner\": {\r\n    \"partner_user\": \"{{InsfirePartnerID}}\",\r\n    \"partner_password\": \"{{InsfirePartnerPassword}}\"\r\n  },\r\n  \r\n  \"agent\": {\r\n    \"fname\": \"Test\",\r\n    \"lname\": \"Amith\",\r\n    \"email\": \"testuser@insuractive.com\",\r\n    \"phone\": \"5555555555\",\r\n    \"address1\": \"400 Test Ln\",\r\n    \"address2\": \"\",\r\n    \"city\": \"Omaha\",\r\n    \"state\": \"NE\",\r\n    \"zip\": \"68114\",\r\n    \"awn\": \"12345678\",\r\n    \"external_id\": \"{{AgentUserID}}\"\r\n  },\r\n  \r\n  \"client\": {\r\n    \"fname\": \"Bob\",\r\n    \"lname\": \"Cliente\",\r\n    \"address1\": \"100 N Test St\",\r\n    \"address2\": \"\",\r\n    \"city\": \"Omaha\",\r\n    \"state\": \"NE\",\r\n    \"zip\": \"68114\",\r\n    \"email\": \"testuser@insuractive.com\",\r\n    \"phone\": \"4025555555\",\r\n    \"tobacco\": \"T\",\r\n    \"gender\": \"F\",\r\n    \"dob\": \"12/01/1956\",\r\n    \"height\": \"5ft 3in\",\r\n    \"weight\": \"135\",\r\n    \"ssn\": \"123456789\",\r\n    \"hicn\": \"123456789A\",\r\n    \"enroll_status\": \"\",\r\n    \"medicare_parta_date\": \"4/1/2013\",\r\n    \"medicare_partb_date\": \"5/2/2014\"\r\n  },\r\n  \r\n  \"notification\": {\r\n    \"notification_method\": \"email\",\r\n    \"notification_address\": \"testuser@insuractive.com\"\r\n  }\r\n}"},"url":"https://{{BaseInsfire}}/api/ABE/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370886/ABE+Invitation+Request+Object\">ABE Invitation Request Object</a></td>\n<td>HTTP Body</td>\n<td>Encapsulates the User and Client information to auto-populate into the ABE form</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3056042084/ABE+Invitation+Response+Object\">ABE Invitation Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates an <strong>EXTREMELY</strong> short lived App By Email (ABE) invitation URL. The expectation is that the API partner will redirect the User immediately to the URL after it has been created. Except in one scenario, the URLs are one-time use only.</p>\n<p>The exception is if the User decides to Save the enrollment without completing the User-facing process. This adds a User-chosen password to the enrollment and renews the invitation expiration date for 24 hours.</p>\n","urlObject":{"protocol":"https","path":["api","ABE",""],"host":["{{BaseInsfire}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81a72c2e-8a12-4281-887d-ff981017d1dc"}],"id":"47ebd763-ca06-48de-8b3a-ed0986b4a907","description":"<p>This section lists the endpoints and calls needed to execute the App By Email (ABE) Enrollment option through the Lead Advantage system.</p>\n<p>Implementation of the App by Email (ABE) feature is significantly different from all other Lead Advantage quoting and enrollment features.</p>\n<ul>\n<li><p>Because of the number of screens the User/Agent must interact with, the ABE feature is built as a weblet instead of a pure API instance</p>\n</li>\n<li><p>Lead Advantage uses the insfire (generically branded) domain to host the ABE process. The weblet can be launched within an iframe for more control over branding.</p>\n</li>\n<li><p>The process starts when API Partners request an App By Email Enrollment Invitation. This invitation is <strong>EXTREMELY</strong> short lived for security purposes (5 seconds). The expectation is that the User's browser is forwarded to the invitation URL immediately after the invite is generated.</p>\n</li>\n</ul>\n<p>Part of the invite process involves the API partner providing a <code>return_url</code> that the insfire system uses to redirect the User's browser (along with a payload of the ABE data) at the end of the ABE User-facing process.</p>\n<p>A complete description of the format of the postback data by use case can be found in the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912146/ABE+Postback+Response+Object\">ABE Postback Response Object</a> documentation</p>\n","_postman_id":"47ebd763-ca06-48de-8b3a-ed0986b4a907"},{"name":"Enroll - Carrier eApp","item":[{"name":"Mutual of Omaha Companies  - Medicare Supplement","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"949f179a-7aac-4c5d-b942-a74faabd0f25","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"external_sso_type\": \"plan\",\r\n  \"external_sso_vendor_id\": \"\",\r\n  \"plan_id\": \"2010_mooc_medsup_f\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"sso_destination_id\": \"2\",\r\n  \"sso_app_data\": {\r\n    \"title\": \"Mr.\",\r\n    \"fname\": \"Bob\",\r\n    \"mname\": \"E\",\r\n    \"lname\": \"Cliente\",\r\n    \"email\": \"bcliente@example.com\",\r\n    \"phone\": \"7035555555\",\r\n    \"dob\": \"12/01/1950\",\r\n    \"address1\": \"123 Home St\",\r\n    \"address2\": \"\",\r\n    \"city\": \"Alexandria\",\r\n    \"state\": \"VA\",\r\n    \"state_name\": \"Virginia\",\r\n    \"zip\": \"22314\",\r\n    \"mailing_address\": \"123 Home St\",\r\n    \"mailing_city\": \"Alexandria\",\r\n    \"mailing_state\": \"VA\",\r\n    \"mailing_zip\": \"22314\",\r\n    \"eff_date\": \"07/01/2017\",\r\n    \"household_discount\": \"true\",\r\n    \"medsup_oegi\": \"OE\",\r\n    \"esrd\": \"false\",\r\n    \"gender\": \"M\",\r\n    \"tobacco\": \"false\",\r\n    \"htft\": \"5\",\r\n    \"htin\": \"11\",\r\n    \"weight\": \"195\",\r\n    \"parta_date\": \"11/1/2016\",\r\n    \"partb_date\": \"11/1/2016\"\r\n  }\r\n}"},"url":"https://{{BaseAPI}}/api/externalSSO/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207056/External+SSO+Request+Object\">External SSO Request Object</a></td>\n<td>HTTP Body</td>\n<td>Encapsulates the User and Client information needed to generate a Single Sign-on request into the Mutual of Omaha eApp system</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829644/External+SSO+Response+Object\">External SSO Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates a Single Sign-on token that may be used the authenticate the user into the Mutual of Omaha Medicare Supplement eApp system. This method may be used to enroll clients into Medicare Supplement products for the following Lead Advantage Insurance Carriers:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Carrier ID</th>\n<th>Carrier Name</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>2589</td>\n<td>Mutual of Omaha</td>\n</tr>\n<tr>\n<td>2628</td>\n<td>Omaha Insurance Company</td>\n</tr>\n<tr>\n<td>2614</td>\n<td>United of Omaha</td>\n</tr>\n<tr>\n<td>2597</td>\n<td>United World</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: The Agent/User must have a valid Agent Writing Number (AWN) on file with the Lead Advantage system AND must be contracted, in good standing and ready to sell for the products associated with the single sign-on attempt</strong></p>\n","urlObject":{"protocol":"https","path":["api","externalSSO",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"949f179a-7aac-4c5d-b942-a74faabd0f25"},{"name":"Mutual of Omaha Companies  - Final Expense","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"9ca162cd-9e2d-4e6f-8fac-39ecc4daa075","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"external_sso_type\": \"plan\",\r\n  \"external_sso_vendor_id\": \"\",\r\n  \"plan_id\": \"omaha_fex_LivingPromise_Graded\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"sso_destination_id\": \"2\",\r\n  \"sso_app_data\": {\r\n\t\"user_fname\": \"Test\",\r\n    \"user_lname\": \"Amith\",\r\n    \"user_phone\": \"4025555555\",\r\n    \"user_email\": \"{{AgentEmail}}\",\r\n    \"user_address\": \"400 Test ln\",\r\n    \"user_city\": \"Omaha\",\r\n    \"user_state\": \"NE\",\r\n    \"user_zip\": \"68114\",\r\n    \"user_update\": \"False\",\r\n    \"title\": \"Mr.\",\r\n    \"fname\": \"Bob\",\r\n    \"mname\": \"E\",\r\n    \"lname\": \"Cliente\",\r\n    \"email\": \"bcliente@example.com\",\r\n    \"phone\": \"7035555555\",\r\n    \"dob\": \"12/01/1950\",\r\n    \"address1\": \"123 Home St\",\r\n    \"address2\": \"\",\r\n    \"city\": \"Alexandria\",\r\n    \"state\": \"VA\",\r\n    \"state_name\": \"Virginia\",\r\n    \"zip\": \"22314\",\r\n    \"mailing_address\": \"123 Home St\",\r\n    \"mailing_city\": \"Alexandria\",\r\n    \"mailing_state\": \"VA\",\r\n    \"mailing_zip\": \"22314\",\r\n    \"eff_date\": \"07/01/2017\",\r\n    \"household_discount\": \"true\",\r\n    \"medsup_oegi\": \"OE\",\r\n    \"esrd\": \"false\",\r\n    \"gender\": \"M\",\r\n    \"tobacco\": \"false\",\r\n    \"htft\": \"5\",\r\n    \"htin\": \"11\",\r\n    \"weight\": \"195\",\r\n    \"parta_date\": \"11/1/2016\",\r\n    \"partb_date\": \"11/1/2016\"\r\n  }\r\n}"},"url":"https://{{BaseAPI}}/api/externalSSO/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207056/External+SSO+Request+Object\">External SSO Request Object</a></td>\n<td>HTTP Body</td>\n<td>Encapsulates the User and Client information needed to generate a Single Sign-on request for United of Omaha Final Expense (iGo)</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829644/External+SSO+Response+Object\">External SSO Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates a Single Sign-on token that may be used the authenticate the user into the United of Omaha final Expense eApp hosted on the iPipeline iGo system. This method may be used to enroll clients into Final Expense products for the following Lead Advantage Insurance Carriers:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Carrier ID</th>\n<th>Carrier Name</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>2614</td>\n<td>United of Omaha</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: The Agent/User must have a valid Agent Writing Number (AWN) on file with the Lead Advantage system AND must be contracted, in good standing and ready to sell for the products associated with the single sign-on attempt</strong></p>\n","urlObject":{"protocol":"https","path":["api","externalSSO",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ca162cd-9e2d-4e6f-8fac-39ecc4daa075"},{"name":"Transamerica - Medicare Supplement","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c7c5a472-2054-432e-bb4a-35111a633f66","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"external_sso_type\": \"plan\",\r\n  \"external_sso_vendor_id\": \"\",\r\n  \"plan_id\": \"2010_tplic_medsup_f\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"sso_destination_id\": \"2\",\r\n  \"sso_app_data\": {\r\n\t\"user_fname\": \"Test\",\r\n    \"user_lname\": \"Amith\",\r\n    \"user_phone\": \"4025555555\",\r\n    \"user_email\": \"{{AgentEmail}}\",\r\n    \"user_address\": \"400 Test ln\",\r\n    \"user_city\": \"Omaha\",\r\n    \"user_state\": \"NE\",\r\n    \"user_zip\": \"68114\",\r\n    \"user_update\": \"False\",\r\n    \"title\": \"Mr.\",\r\n    \"fname\": \"Bob\",\r\n    \"mname\": \"E\",\r\n    \"lname\": \"Cliente\",\r\n    \"email\": \"bcliente@example.com\",\r\n    \"phone\": \"7035555555\",\r\n    \"dob\": \"12/01/1950\",\r\n    \"address1\": \"123 Home St\",\r\n    \"address2\": \"\",\r\n    \"city\": \"Alexandria\",\r\n    \"state\": \"VA\",\r\n    \"state_name\": \"Virginia\",\r\n    \"zip\": \"22314\",\r\n    \"mailing_address\": \"123 Home St\",\r\n    \"mailing_city\": \"Alexandria\",\r\n    \"mailing_state\": \"VA\",\r\n    \"mailing_zip\": \"22314\",\r\n    \"eff_date\": \"07/01/2017\",\r\n    \"household_discount\": \"true\",\r\n    \"medsup_oegi\": \"OE\",\r\n    \"esrd\": \"false\",\r\n    \"gender\": \"M\",\r\n    \"tobacco\": \"false\",\r\n    \"htft\": \"5\",\r\n    \"htin\": \"11\",\r\n    \"weight\": \"195\",\r\n    \"parta_date\": \"11/1/2016\",\r\n    \"partb_date\": \"11/1/2016\"\r\n  }\r\n}"},"url":"https://{{BaseAPI}}/api/externalSSO/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207056/External+SSO+Request+Object\">External SSO Request Object</a></td>\n<td>HTTP Body</td>\n<td>Encapsulates the User and Client information needed to generate a Single Sign-on request for TPLIC Medsup (iGo)</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829644/External+SSO+Response+Object\">External SSO Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates a Single Sign-on token that may be used the authenticate the user into the TPLIC Medicare Supplement eApp hosted on the iPipeline iGo system. This method may be used to enroll clients into Medicare Supplement products for the following Lead Advantage Insurance Carriers:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Carrier ID</th>\n<th>Carrier Name</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>2648</td>\n<td>Transamerica Premier Life Insurance Company</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: The Agent/User must have a valid Agent Writing Number (AWN) on file with the Lead Advantage system AND must be contracted, in good standing and ready to sell for the products associated with the single sign-on attempt</strong></p>\n","urlObject":{"protocol":"https","path":["api","externalSSO",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7c5a472-2054-432e-bb4a-35111a633f66"},{"name":"Silverscript - Part D","event":[{"listen":"test","script":{"id":"2cb70f04-7b83-4d7e-81d4-02856622894d","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c2f57284-3ad5-4b23-8671-459212303fff","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"external_sso_type\": \"plan\",\r\n\t\"external_sso_vendor_id\": \"\",\r\n\t\"plan_id\": \"{{PlanID}}\",\r\n\t\"user_id\": \"{{AgentUserID}}\",\r\n\t\"sso_destination_id\": \"2\",\r\n\t\"sso_app_data\": {\r\n\t\t\"applicationDate\": \"8/1/2017\",\r\n\t\t\"apprecDate\": \"\",\r\n\t\t\"bankAccountHolderName\": \"\",\r\n\t\t\"bankAccountNumber\": \"\",\r\n\t\t\"bankAccountType\": \"\",\r\n\t\t\"bankName\": \"\",\r\n\t\t\"bankRoutingNumber\": \"\",\r\n\t\t\"beneficiaryBirthDate\": \"1/1/1950\",\r\n\t\t\"beneficiaryEmail\": \"tester@example.com\",\r\n\t\t\"beneficiaryFirstName\": \"Jane\",\r\n\t\t\"beneficiaryGender\": \"F\",\r\n\t\t\"beneficiaryHicNumber\": \"\",\r\n\t\t\"beneficiaryLastName\": \"Doe\",\r\n\t\t\"beneficiaryMI\": \"A\",\r\n\t\t\"beneficiaryMobilePhone\": \"\",\r\n\t\t\"beneficiaryPhoneNumber\": \"1234567890\",\r\n\t\t\"beneficiarySuffix\": \"\",\r\n\t\t\"beneficiaryTitle\": \"\",\r\n\t\t\"effectiveDate\": \"9/1/2018\",\r\n\t\t\"electionStatus\": \"\",\r\n\t\t\"eligibilityDate\": \"\",\r\n\t\t\"eligibilityReasons\": \"\",\r\n\t\t\"enrollmentMethod\": \"\",\r\n\t\t\"hasSecondaryCoverage\": \"\",\r\n\t\t\"ltcName\": \"\",\r\n\t\t\"ltcPhone\": \"\",\r\n\t\t\"mailingAddressIsSame\": \"FALSE\",\r\n\t\t\"mailingAddressLine1\": \"\",\r\n\t\t\"mailingAddressLine2\": \"\",\r\n\t\t\"mailingCity\": \"\",\r\n\t\t\"mailingCounty\": \"\",\r\n\t\t\"mailingState\": \"\",\r\n\t\t\"mailingZipCode\": \"\",\r\n\t\t\"noneApply\": \"FALSE\",\r\n\t\t\"partAEffectiveDate\": \"8/1/2017\",\r\n\t\t\"partBEffectiveDate\": \"8/1/2017\",\r\n\t\t\"paymentMethod\": \"\",\r\n\t\t\"planState\": \"VA\",\r\n\t\t\"plantype\": \"C\",\r\n\t\t\"poaAddress\": \"\",\r\n\t\t\"poaCity\": \"\",\r\n\t\t\"poaDuplicate\": \"FALSE\",\r\n\t\t\"poaName\": \"\",\r\n\t\t\"poaPhone\": \"\",\r\n\t\t\"poaRelationship\": \"\",\r\n\t\t\"poaState\": \"\",\r\n\t\t\"poaZipCode\": \"\",\r\n\t\t\"preferredLanguage\": \"\",\r\n\t\t\"residenceAddressLine1\": \"400 PITT ST\",\r\n\t\t\"residenceAddressLine2\": \"\",\r\n\t\t\"residenceCity\": \"ALEXANDRIA\",\r\n\t\t\"residenceCounty\": \"ALEXANDRIA\",\r\n\t\t\"residenceState\": \"VA\",\r\n\t\t\"residenceZipCode\": \"22314\",\r\n\t\t\"secondaryCoverageEffectiveDate\": \"\",\r\n\t\t\"secondaryCoverageIdNumber\": \"\",\r\n\t\t\"secondaryCoveragePlanName\": \"\",\r\n\t\t\"secondaryCoveragerXbin\": \"\",\r\n\t\t\"secondaryCoveragerXgroup\": \"\",\r\n\t\t\"secondaryCoveragerXpcn\": \"\",\r\n\t\t\"secondaryCoverageTermDate\": \"\",\r\n\t\t\"soaIncluded\": \"\",\r\n\t\t\"soaNotIncludedMail\": \"\"\r\n\t}\r\n}"},"url":"https://{{BaseAPI}}/api/externalSSO/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207056/External+SSO+Request+Object\">External SSO Request Object</a></td>\n<td>HTTP Body</td>\n<td>Encapsulates the User and Client information needed to generate a Single Sign-on request into the SilverScript eApp system</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829644/External+SSO+Response+Object\">External SSO Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates a Single Sign-on token that may be used the authenticate the user into the SilverScript eApp system. This method may be used to enroll clients into Part D products for the following Lead Advantage Insurance Carriers:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Carrier ID</th>\n<th>Carrier Name</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>2603</td>\n<td>SilverScript</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: The Agent/User must have a valid Agent Writing Number (AWN) on file with the Lead Advantage system AND must be contracted, in good standing and ready to sell for the products associated with the single sign-on attempt</strong></p>\n","urlObject":{"protocol":"https","path":["api","externalSSO",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2f57284-3ad5-4b23-8671-459212303fff"}],"id":"276efbd7-a1f7-4283-bcc9-a2780e49918a","description":"<p>This section lists the endpoints and calls needed to single sign-on into an Insurance Carrier eApp or Agent Portal.  Specifics on what information is required does vary by Insurance Carrier, so please check the documentation to determine what fields are needed for the Carrier/Product you are trying to access.</p>\n","_postman_id":"276efbd7-a1f7-4283-bcc9-a2780e49918a"},{"name":"Enroll - eSig Scope of Appointment","item":[{"name":"01 Preview Scope of Appointment Message","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"a21f7fff-2e70-4939-87c4-341aac8a27e9","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"draft\":\"1\",\r\n  \"lead_id\": \"{{SampleLeadID}}\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"user_carrier_id\": \"{{AgentUserCarrierID}}\",\r\n  \"client_name\": \"Bob Cliente\",\r\n  \"client_email\": \"{{SampleLeadEmail}}\",\r\n  \"client_dob\": \"1950-12-01\",\r\n  \"client_zip\": \"22314\",\r\n  \"plan_name\": \"Aetna Medicare Innovation Choice Plan (PPO)\",\r\n  \"plan_id\": \"2017_H5521_027_000\",\r\n  \"process_type\": \"SOA\",\r\n  \"external_redirect_url\": \"\",\r\n  \"notify_web_hook_url\": \"\",\r\n  \"alert_notice\": \"0\",\r\n  \"alert_email\": \"1\",\r\n  \"soa\": {\r\n    \"lead_id\": \"{{SampleLeadID}}\",\r\n    \"user_id\": \"{{AgentUserID}}\",\r\n    \"carrier_id\": \"2609\",\r\n    \"plan_id\": \"2017_H5521_027_000\",\r\n    \"client_name\": \"Bob Cliente\",\r\n    \"client_phone\": \"5555551111\",\r\n    \"client_address\": \"123 Test Ln. Alexandria, VA 22314\",\r\n    \"rep_name\": \"Brenda Cliente\",\r\n    \"rep_relation\": \"daughter\",\r\n    \"agent_name\": \"Test Amith\",\r\n    \"agent_phone\": \"703-555-1111\",\r\n    \"agent_address\": \"400 Test St, Omaha NE\",\r\n    \"contact_method\": \"phone\",\r\n    \"medicare_plans\": \"Medicare Part C and D\",\r\n    \"soa_just_in_time_reason\": \"phone call\",\r\n    \"appointment_date\": \"2017-06-05\"\r\n  }\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a> payload</td>\n<td>HTTP Body</td>\n<td>Includes information needed to generate a client invitation email for the esignature Scope of Appointment system</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with populated <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a> information</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Generates a Scope of Appointment record in <strong>DRAFT mode</strong> to allow API partners to provide a preview of the scope of appointment email content to their users</p>\n<p>DRAFT mode generates a scope of appointment record but suspends the sending of the message until the Client Invite message is updated with the property <code>\"draft\":\"0\"</code>.</p>\n<p>If you wish to generate the SOA client Invitation and send it to the client in a single step, you can create the SOA Client Invitation using this same call with the property <code>\"draft\":\"0\"</code>.</p>\n<p><strong>REQUIREMENTS: All Lead Advantage users must have a valid Agent Writing Number on file for the specified carrier in the Lead Advantage system before an esignature scope of appointment can be sent.</strong></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a21f7fff-2e70-4939-87c4-341aac8a27e9"},{"name":"02 Send Scope of Appointment Invitation Message","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"2348e51c-3f8b-4b13-84cb-db9f71536189","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"draft\": \"0\",\r\n  \"client_invite_id\": \"{{ClientInviteSOAID}}\",\r\n  \"soa\": {\r\n    \"soa_id\": \"60\",\r\n    \"lead_id\": \"11678\",\r\n    \"user_id\": \"9278\",\r\n    \"carrier_id\": \"2609\",\r\n    \"plan_id\": \"2017_H5521_027_000\",\r\n    \"client_initial_partd\": \"\",\r\n    \"client_initial_medadvantage\": \"\",\r\n    \"client_esign_id\": \"\",\r\n    \"client_esign_date\": \"\",\r\n    \"client_name\": \"Bob Cliente\",\r\n    \"client_phone\": \"5555551111\",\r\n    \"client_address\": \"123 Test Ln. Alexandria, VA 22314\",\r\n    \"rep_name\": \"Brenda Cliente\",\r\n    \"rep_relation\": \"daughter\",\r\n    \"agent_name\": \"Test Amith\",\r\n    \"agent_phone\": \"703-555-1111\",\r\n    \"agent_address\": \"400 Test St, Omaha NE\",\r\n    \"agent_esign_id\": \"\",\r\n    \"contact_method\": \"phone\",\r\n    \"medicare_plans\": \"Medicare Part C and D\",\r\n    \"soa_just_in_time_reason\": \"phone call\",\r\n    \"appointment_date\": \"2017-06-05T04:00:00Z\",\r\n    \"access_date\": \"\",\r\n    \"submitted_date\": \"\"\r\n  }\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td>Simplified <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a> payload</td>\n<td>HTTP Body</td>\n<td>Identifies Client invitation and Scope of Appointment record to send</td>\n</tr>\n<tr>\n<td>Returns: Full <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with populated <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a> information</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Updates a Client Invitation / Scope of Appointment record that has been saved in <strong>DRAFT mode</strong> and sends the pending Email Message containing the invitation to the client</p>\n<p>Note:</p>\n<ul>\n<li><p>When updating the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> record to send the SOA you may reduce the object to only include the <code>draft</code> and <code>client_invite_id</code> properties as seen in the example below. However you must provide the full <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a> in the <code>soa</code> property.</p>\n</li>\n<li><p>Instructions on how to create a Client Invitation for Scope of Appointment in <strong>DRAFT mode</strong> is described in <a href=\"https://apidocs.leadadvantagepro.com/#b51eb89c-eeba-9d85-e6ed-65ed67b232c8\">Step 01</a> of the eSignatureSOA Process.</p>\n</li>\n<li><p>If you wish to generate the SOA client Invitation and send it to the client in a single step, you can create the SOA Client Invitation using this same call with the property <code>\"draft\":\"0\"</code>.</p>\n</li>\n</ul>\n<p><strong>REQUIREMENTS: All Lead Advantage users must have a valid Agent Writing Number on file for the specified carrier in the Lead Advantage system before an esignature scope of appointment can be sent.</strong></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2348e51c-3f8b-4b13-84cb-db9f71536189"},{"name":"03 Check for Client eSignature","id":"692ea8c6-b010-4769-aeb2-d7df1b9cc056","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/soa/{{SOAID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>soa_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Scope of Appointment record to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve a Scope of Appointment record stored in in Lead Advantage. The SOA ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/soa/{{SOAID}})</p>\n<p>Note:</p>\n<ul>\n<li>This step should be triggered when the Client has completed and signed the Scope of Appointment form.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","soa","{{SOAID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"692ea8c6-b010-4769-aeb2-d7df1b9cc056"},{"name":"04 Retrieve Client eSignature Data","id":"39d1671f-c3b2-439d-bd70-5234ab9b9906","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/esignature/{{eSignatureID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>esignature_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Electronic Signature record to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207075/eSignature+Object\">eSignature Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve an eSignature record stored in in Lead Advantage. The eSignature ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/esignature/{{eSignatureID}})</p>\n<p>Note:</p>\n<ul>\n<li><p>This step should be triggered when the Client has completed and signed the Scope of Appointment form.</p>\n</li>\n<li><p>The value of the <code>data</code> property includes the completed HTML form signed by the client. this value should be used as the <code>data</code> element of the User/Agent's esignature record (to be created in the next step)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","esignature","{{eSignatureID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"39d1671f-c3b2-439d-bd70-5234ab9b9906"},{"name":"05 Capture Agent eSignature","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"46bdf2fe-2b79-42e2-8e98-edd0b3a08c39","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"account_id\": \"{{AgentAccountID}}\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"esignature_type_id\": \"1\",\r\n  \"data\": \"DOCUMENT_TO_ESIGN_GOES_HERE\",\r\n  \"signature\": \"Test Amith\",\r\n  \"signature_date\": \"2017-06-05T19:52:00\"\r\n}"},"url":"https://{{BaseAPI}}/api/esignature ","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207075/eSignature+Object\">eSgnature Object</a></td>\n<td>HTTP Body</td>\n<td>Captures the system actor's signature record and signed data packet</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207075/eSignature+Object\">eSgnature Object</a> with hashed signature information populated</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Captures the signature of the User/Agent along with the data/document that the actor is signing. This information is hashed for verification purposes and returned with the record. Record the <code>esignature_id</code> for use in Step 04.</p>\n<p>Note:</p>\n<ul>\n<li><p>This step should only be triggered once the Client applies an eSignature record to the associated <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a>.</p>\n</li>\n<li><p>In the case on Scope of Appointment User/Agent eSignatures, we recommend using the data property of the Client eSignature record (assuming the Client signs first) as the source of <code>data</code> for the User/Agent eSignature record as well.**</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","esignature "],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46bdf2fe-2b79-42e2-8e98-edd0b3a08c39"},{"name":"06 Apply Agent eSignature to SOA","id":"ba907f68-83c0-48fd-813c-951611a13f03","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"soa_id\": \"61\",\n  \"agent_esign_id\": \"5\"\n}"},"url":"https://{{BaseAPI}}/api/soa/{{SOAID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>soa_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Scope of Appointment record to perform action on</td>\n</tr>\n<tr>\n<td>body</td>\n<td>Simplified <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a></td>\n<td>HTTP Body</td>\n<td>Simplified Scope of Appointment object that includes only <code>soa_id</code> and <code>agent_esign_id</code> properties</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Apply an Agent eSignature record to a Scope of Appointment record stored in in Lead Advantage. The SOA ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/soa/{{SOAID}})</p>\n<p>Note:</p>\n<ul>\n<li>This step should be triggered when both the Client and User have signed the SOA data</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","soa","{{SOAID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba907f68-83c0-48fd-813c-951611a13f03"},{"name":"07 Get eSOA HTML Document","id":"66b397ca-8375-45b1-a9f9-377f06a1d2d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"soa_id\": \"61\"\n}"},"url":"https://{{BaseAPI}}/api/soa/{{SOAID}}/document/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>soa_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Scope of Appointment record to perform action on</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a></p>\n<p>Get HTML code that generates the original scope of appointment page along with any filled fields and captured signatures. Useful for displaying in a stand alone window.</p>\n","urlObject":{"protocol":"https","path":["api","soa","{{SOAID}}","document",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"66b397ca-8375-45b1-a9f9-377f06a1d2d4"},{"name":"08 Get eSOA PDF Document","id":"f9ebeacd-dd2e-4984-9b59-ff92b15454e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"soa_id\": \"61\"\n}"},"url":"https://{{BaseAPI}}/api/soa/{{SOAID}}/pdf/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>soa_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Scope of Appointment record to perform action on</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633070/Scope+of+Appointment+Object\">Scope of Appointment Object</a></p>\n<p>Get a link to a PDF of the existing scope of appointment page along with any filled fields and captured signatures. Useful for download or display via browser or PDF viewer.</p>\n","urlObject":{"protocol":"https","path":["api","soa","{{SOAID}}","pdf",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9ebeacd-dd2e-4984-9b59-ff92b15454e4"}],"id":"b7eb5bd6-98d5-45ae-98f7-e44723c1d0e9","description":"<p>This section lists the endpoints and calls needed to execute the esignature Scope of Appointment tool in the Lead Advantage API</p>\n","_postman_id":"b7eb5bd6-98d5-45ae-98f7-e44723c1d0e9"},{"name":"Geographic Utilities","item":[{"name":"List Counties in a Specific ZIP Code","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"97658363-4486-4d5c-a5b0-a1ce0e0f0eed","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/geo/countiesByZip/{{AgentZIP}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ZIP</td>\n<td>string(5)</td>\n<td>Path</td>\n<td>Valid 5-digit US ZIP code to retrieve counties for</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403726/State-County+Objects\">State-County Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve a list of counties associated with a valid 5 digit ZIP code. The ZIP code is passed in the URL path (e.g. {{BaseAPI}}/api/geo/countiesByZip/{{AgentZIP}})</p>\n<p><strong>Note: ZIP codes can span County and State borders, so the response includes both the counties and states assocaited with the requested ZIP code</strong></p>\n","urlObject":{"protocol":"https","path":["api","geo","countiesByZip","{{AgentZIP}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"97658363-4486-4d5c-a5b0-a1ce0e0f0eed"}],"id":"e63b0d6d-eb51-4806-9a34-ed854df1d767","description":"<p>Many features of the Lead Advantage system are dependent on the user's or client's geographic location.  This section lists the endpoints that deal with geographic searching and geolocation.</p>\n","_postman_id":"e63b0d6d-eb51-4806-9a34-ed854df1d767"},{"name":"Insurance Carriers & Plans","item":[{"name":"View Insurance Carrier Information","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"5263fc88-9b64-47be-a2a6-e3ce2f31c115","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/carrier/{{CarrierID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>carrier_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for the Carrier to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912180/Carrier+Object\">Carrier Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve information on a carrier used in Lead Advantage. The Carrier ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/carrier/{{CarrierID}})</p>\n","urlObject":{"protocol":"https","path":["api","carrier","{{CarrierID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5263fc88-9b64-47be-a2a6-e3ce2f31c115"},{"name":"Search for Insurance Carriers","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"a0eb6632-0ded-412f-9852-cd2802541bdf","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"active\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"true\"]\r\n    }\r\n  },\r\n  \"field_list\": \"carrier_id,short_name,name,app_email,naic\"\r\n}\r\n\r\n\r\n"},"url":"https://{{BaseAPI}}/api/carrier/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Carrier Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912180/Carrier+Object\">Carrier Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for insurance carriers supported by Lead Advantage. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Carrier fields available for use in searches include:</p>\n<ul>\n<li><p><code>active</code></p>\n</li>\n<li><p><code>carrier_id</code></p>\n</li>\n<li><p><code>company_id</code></p>\n</li>\n<li><p><code>name</code></p>\n</li>\n<li><p><code>NAIC</code></p>\n</li>\n<li><p><code>short_name</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","carrier","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0eb6632-0ded-412f-9852-cd2802541bdf"},{"name":"View Insurance Plan Information","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"7a4b16c5-eab7-46aa-ae0e-25d0effbff7b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/plan/{{PlanID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>plan_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for the Plan to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403751/Plan+Object\">Plan Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve information on an insurance plan/product used in Lead Advantage. The Plan ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/plan/{{PlanID}})</p>\n","urlObject":{"protocol":"https","path":["api","plan","{{PlanID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a4b16c5-eab7-46aa-ae0e-25d0effbff7b"},{"name":"Search for Insurance Plans","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"1e32f9a7-0e00-413d-ad9d-38f4c51d7b80","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"plan_id\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"2017_H0028%\"]\r\n    },\r\n    \"sms_plan\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"true\"]\r\n    },\r\n    \"available\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"true\"]\r\n    }\r\n    \r\n  },\r\n  \"field_list\": \"\"\r\n}\r\n\r\n\r\n"},"url":"https://{{BaseAPI}}/api/plan/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Plan Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403751/Plan+Object\">Plan Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for insurance plans supported by Lead Advantage. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403751/Plan+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Plan fields available for use in searches include:</p>\n<ul>\n<li><p><code>carrier_id</code></p>\n</li>\n<li><p><code>company_id</code></p>\n</li>\n<li><p><code>company_name</code></p>\n</li>\n<li><p><code>company_short_name</code></p>\n</li>\n<li><p><code>plan_id</code></p>\n</li>\n<li><p><code>plan_name</code></p>\n</li>\n<li><p><code>plan_year</code></p>\n</li>\n<li><p><code>product_type_id</code></p>\n</li>\n<li><p><code>product_type_name</code></p>\n</li>\n<li><p><code>sms_plan</code> (boolean)</p>\n</li>\n<li><p><code>available</code> (boolean)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","plan","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e32f9a7-0e00-413d-ad9d-38f4c51d7b80"}],"id":"40ad45fb-c6b9-4a99-b8e7-2b2e3c3b7e1e","description":"<p>Many of the Lead Advantage API functions require indentifiers for the Insurance Carriers and Plans.  This section lists the endpoints that provide the collection of available carriers and plans in the Lead Advantage API platform</p>\n","_postman_id":"40ad45fb-c6b9-4a99-b8e7-2b2e3c3b7e1e"},{"name":"Insurance Documents & Forms","item":[{"name":"Drilldown 01 - List Product Types with Available Forms","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"f2e59449-301c-4ab7-a02f-3c1d0dc22b74","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"carrier_id\":\"6684\",\r\n  \"county_fips\":\"51001\",\r\n    \"plan_year\":\"2015\",\r\n  \"product_type_id\":\"9\",\r\n  \"state_id\":\"VA\"\r\n}"},"url":"https://{{BaseAPI}}/api/document/drilldown/productType/","description":"<p>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912194/Product+Type+Drilldown+Object\">Product Type Drilldown Object</a></p>\n<p>Retrieve a collection of Product Types associated with the forms currently loaded in the Lead Advantage system. For Medicare Advantage and Part D plans, the result set includes a list of the plan years for which Lead Advantage has documents/forms loaded.</p>\n","urlObject":{"protocol":"https","path":["api","document","drilldown","productType",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2e59449-301c-4ab7-a02f-3c1d0dc22b74"},{"name":"Drilldown 02 - List States with Available Forms","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"8caad368-f6b1-4601-8f61-6a7447faaec6","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"product_type_id\":\"{{FormProductTypeID}}\",\r\n  \"plan_year\":\"{{FormPlanYear}}\"\r\n}"},"url":"https://{{BaseAPI}}/api/document/drilldown/states/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Document Drilldown Search Criteria (required: <code>product_type_id</code>, <code>plan_year</code>)</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338209/State+Objects\">State Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Once you have selected a product type, use this endpoint to determine what states currently have active forms in the Lead Advantage system.</p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","document","drilldown","states",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8caad368-f6b1-4601-8f61-6a7447faaec6"},{"name":"Drilldown 03 - List Counties in State","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"7d63bcd4-90f0-4d1d-8853-e37c661af081","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"state_id\":\"{{FormStateID}}\"\r\n}"},"url":"https://{{BaseAPI}}/api/document/drilldown/counties/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Document Drilldown Search Criteria (required: <code>state_id</code>)</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403767/County+Objects\">County Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Once you have selected a product type and state, use this endpoint to determine what counties are available in the selected state.</p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","document","drilldown","counties",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d63bcd4-90f0-4d1d-8853-e37c661af081"},{"name":"Drilldown 04 - List Carriers with Available Forms","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"8c693e75-149d-4583-9474-116a5ae1f3f6","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"product_type_id\":\"{{FormProductTypeID}}\",\r\n  \"plan_year\":\"{{FormPlanYear}}\",\r\n  \"state_id\":\"{{FormStateID}}\",\r\n  \"county_fips\":\"{{FormCountyFIPS}}\"\r\n}"},"url":"https://{{BaseAPI}}/api/document/drilldown/carriers/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Document Drilldown Search Criteria (required: <code>product_type_id</code>, <code>plan_year</code> (MA/PD Only), <code>state_id</code>, <code>county_fips</code> (MA/PD Only)</td>\n</tr>\n<tr>\n<td>Returns: Array of <strong>simplified</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912180/Carrier+Object\">Carrier Objects</a> (includes only <code>carrier_name</code> and <code>carrier_id</code>)</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Once you have selected a product type, state and county (where applicable), use this endpoint to determine what Carriers currently have active forms matching the criteria in the Lead Advantage system.</p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731338/Document+Drilldown+Search+Criteria+Object\">Document Drilldown Search Criteria Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","document","drilldown","carriers",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c693e75-149d-4583-9474-116a5ae1f3f6"},{"name":"Drilldown 05 - List Available Forms","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"b39bf93a-0848-434f-a3dd-8e24b144b1f1","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"product_type_id\":\"{{FormProductTypeID}}\",\r\n  \"plan_year\":\"{{FormPlanYear}}\",\r\n  \"state_id\":\"{{FormStateID}}\",\r\n  \"county_fips\":\"{{FormCountyFIPS}}\",\r\n  \"carrier_id\":{{FormCarrierID}}\"\r\n}"},"url":"https://{{BaseAPI}}/api/document/drilldown/plans/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403767/County+Objects\">Document Drilldown Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Document Drilldown Search Criteria (required: <code>product_type_id</code>, <code>plan_year</code> (MA/PD Only), <code>state_id</code>, <code>county_fips</code> (MA/PD Only), <code>carrier_id</code></td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469214/Plan+Form+Result+Objects\">Plan Form Result Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Once you have selected a product type, state, county (where applicable) and carrier, use this endpoint to obtain a collection of plans and their active forms in the Lead Advantage system.</p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403767/County+Objects\">Document Drilldown Search Criteria Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","document","drilldown","plans",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b39bf93a-0848-434f-a3dd-8e24b144b1f1"},{"name":"List the Forms for a Plan/Product","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"a0ef8676-6203-481e-acc1-2f11b83e8fab","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"search_type\": \"simple\",\r\n    \"criteria\": \r\n    {\r\n        \"plan_id\": {\r\n            \"type\": \"simple\",\r\n            \"value\": [\r\n                \"2010_gpm_medsup_f\"\r\n            ]\r\n        },\r\n        \"document_state_id\": {\r\n        \t\"type\": \"simple\",\r\n        \t\"value\": [\r\n        \t\t\"IL\"\r\n        \t]\r\n        },\r\n        \"active\": {\r\n        \t\"type\": \"simple\",\r\n        \t\"value\": [\r\n        \t\t\"true\"\r\n        \t]\r\n        }\r\n    },\r\n    \"field_list\": \"\"\r\n}\r\n"},"url":"https://{{BaseAPI}}/api/document/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Document/Form Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665884/Document+Objects\">Document Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for documents associated with a Lead Advantage plan/product record. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Document fields available for search include:</p>\n<ul>\n<li><p><code>active</code> (boolean)</p>\n</li>\n<li><p><code>carrier_id</code></p>\n</li>\n<li><p><code>company_id</code></p>\n</li>\n<li><p><code>consumer</code></p>\n</li>\n<li><p><code>deleted</code></p>\n</li>\n<li><p><code>document_library_id</code></p>\n</li>\n<li><p><code>document_state_id</code></p>\n</li>\n<li><p><code>document_type_id</code></p>\n</li>\n<li><p><code>form_number</code></p>\n</li>\n<li><p><code>plan_id</code></p>\n</li>\n<li><p><code>plan_year</code></p>\n</li>\n<li><p><code>product_type_id</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","document","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0ef8676-6203-481e-acc1-2f11b83e8fab"}],"id":"07ddaf77-b784-4c64-a7d5-506e519887fd","description":"<p>Functionality to search and retrieve documents and forms associated with the insurance products supported by the Lead Advantage system.</p>\n<p>Please refer to the section on Codes &amp; Enumerations above for a list of supported document/form types</p>\n","_postman_id":"07ddaf77-b784-4c64-a7d5-506e519887fd"},{"name":"Lead","item":[{"name":"Lead - Importing from CSV","item":[{"name":"View CSV Template and Instructions","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"087ed811-8424-4516-b0ab-14a90410e376","request":{"method":"GET","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"body":{"mode":"raw","raw":"{\n    \"search_type\": \"simple\",\n    \"criteria\": {\n        \"user_id\": {\n            \"type\": \"simple\",\n            \"value\": [\"20\",\"24\"]\n        },\n        \"product_type_id\":\"3\",\n        \"product_type_name\":\"fex\"\n    },\n  \"records_per_page\":\"3\",\n  \"page_number\":\"1\",\n    \"field_list\": \"lead_id,fname,lname,product_types,total_product_types\"\n}"},"url":"https://{{BaseAPI}}/api/leadImportFile/template/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>N/A</td>\n<td>N/A</td>\n<td></td>\n<td>N/A</td>\n</tr>\n<tr>\n<td>Returns: an Object containing a template and instructions property</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve URLs pointing to the current CSV lead import template as well as instructions on how to configure data to use in the CSV template.</p>\n","urlObject":{"protocol":"https","path":["api","leadImportFile","template",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"087ed811-8424-4516-b0ab-14a90410e376"},{"name":"01 - Create a Lead Import File record","id":"df316023-aeba-4bb1-9fe9-fcd81c22d407","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n    \"account_id\":\"62168\"\n  , \"user_id\":\"51760\"\n  , \"target_account_id\":\"62168\"\n  , \"target_user_id\":\"\"\n  , \"alert_email\":\"true\"\n  , \"alert_notice\":\"true\"\n  , \"notify_webhook_url\":\"\"\n}\n            "},"url":"https://{{BaseAPI}}/api/leadImportFile/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054043260/Lead+Import+File+object\">Lead Import File object</a></td>\n<td>integer</td>\n<td>HTTP Body</td>\n<td>Information about CSV file to upload</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054043260/Lead+Import+File+object\">Lead Import File object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Identifies the destination (distribution) for leads that will be imported via an uploaded CSV file and provides an option to configure alerting when import operation is complete</p>\n","urlObject":{"protocol":"https","path":["api","leadImportFile",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"df316023-aeba-4bb1-9fe9-fcd81c22d407"},{"name":"02 - Upload CSV contents (binary) to Lead Advantage","id":"be2d02da-c054-43b1-b803-8334c413257b","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"body":{"mode":"file","file":{}},"url":"https://{{BaseAPI}}/api/leadImportFile/{{LeadImportFileID}}/fileUpload/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_import_file_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Lead Import File API object used to upload CSV data</td>\n</tr>\n<tr>\n<td>Returns:</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Uploads the physical contents of a lead import CSV file (as binary data) and loads the data into the Lead Advantage Account (and User) defined in the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054043260/Lead+Import+File+object\">Lead Import File object</a> whose ID is specified in the URL path</p>\n","urlObject":{"protocol":"https","path":["api","leadImportFile","{{LeadImportFileID}}","fileUpload",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be2d02da-c054-43b1-b803-8334c413257b"}],"id":"75a9b42b-1942-4abf-8020-3b59d34cbbaf","description":"<p>The following section deals with API functionality that may be used to import a CSV containing lead &amp; client information into Lead Advantage</p>\n","_postman_id":"75a9b42b-1942-4abf-8020-3b59d34cbbaf"},{"name":"View an Existing Lead","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"8fc60dfb-dfc9-464f-b9be-a1405ce61269","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Lead to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve a lead record stored in in Lead Advantage. The Lead ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}})</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fc60dfb-dfc9-464f-b9be-a1405ce61269"},{"name":"Create a New Lead","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AgentOtherUserID\", data.user_id);","postman.setEnvironmentVariable(\"AgentOtherUserAddressID\", data.default_address.address_id);","postman.setEnvironmentVariable(\"AgentOtherUserEmailID\", data.default_email.email_id);","postman.setEnvironmentVariable(\"AgentOtherUserPhoneID\", data.default_phone.phone_id);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c62e7949-ac13-474a-8f22-ec68a570ad5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"fname\": \"Gran\",\r\n    \"mname\": \"E\",\r\n    \"lname\": \"Smith\",\r\n    \"title\": \"MRS.\",\r\n    \"gender\": \"F\",\r\n    \"dob\": \"1952-01-01\",\r\n    \"ssn\": \"123-45-6789\",\r\n    \"marital_status\": \"S\",\r\n    \"account_id\":\"{{AgentAccountID}}\",\r\n    \"user_id\":\"{{AgentUserID}}\",\r\n    \"product_type_id\":\"9\",\r\n    \"lead_type_id\":\"1\",\r\n    \"addresses\": [\r\n        {\r\n            \"address_type_id\": \"home\",\r\n            \"address1\": \"123 Home St.\",\r\n            \"city\": \"Alexandria\",\r\n            \"state_id\": \"VA\",\r\n            \"zip\": \"22314\",\r\n            \"county\": \"Alexandria City\",\r\n            \"active\": \"true\"\r\n        }\r\n    ],\r\n    \"phones\": [\r\n        {\r\n            \"phone_type\": \"home\",\r\n            \"phone\": \"7035555555\",\r\n            \"phone_ext\": \"\",\r\n            \"active\": \"true\"\r\n        }\r\n    ],\r\n    \"emails\": [\r\n        {\r\n            \"email_type\": \"home\",\r\n            \"email\": \"client@example.com\",\r\n            \"active\": \"true\"\r\n        }\r\n    ],\r\n    \"lead_notification_addresses\": [\r\n        {\r\n            \"lead_notification_address_type_id\": \"1\",\r\n            \"lead_notification_address\": \"https://mybusiness.com/postback\",\r\n            \"active\": \"1\"\r\n        }\r\n    ],\r\n    \"leads_related\": [ ],\r\n    \"preferred_contact_method\": \"email\",\r\n    \"first_contact_date\": \"\",\r\n    \"last_contact_date\": \"\"\r\n}"},"url":"https://{{BaseAPI}}/api/lead/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Object</a></td>\n<td>HTTP Body</td>\n<td>Lead object to add to Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Create a new lead record. The following data is required for all new leads:</p>\n<ul>\n<li>lname - Lead's last name</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","lead",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c62e7949-ac13-474a-8f22-ec68a570ad5b"},{"name":"Update an Existing Lead","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AgentOtherUserID\", data.user_id);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"5f629cf8-1c0f-45d3-a2aa-a12ae306b92e","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"fname\": \"Gramps\",\r\n    \"lname\": \"Smith\",\r\n    \"gender\": \"M\",\r\n    \"dob\": \"1945-01-01\"\r\n}"},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for existing Lead profile to update</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Object</a></td>\n<td>HTTP Body</td>\n<td>Lead Object containing fields to update in existing Lead profile</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Update the information stored in an existing Lead. The Lead ID of the record to update is included in the URL Path (e.g. {{BaseAPI}}/api/user/{{SampleLeadID}}) You can provide a complete <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Object</a> to update all fields in the lead profile, or you can provide a partial collection of only those fields you would like to update in the profile.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f629cf8-1c0f-45d3-a2aa-a12ae306b92e"},{"name":"Search for Leads","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"bc306e60-8f8a-44b4-be46-3d6165489efd","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"search_type\": \"simple\",\n  \"criteria\": \n    {\n      \"account_id\":{\n      \"type\":\"simple\",\n      \"value\":[\"{{AgentAccountID}}\"]\n      }\n    },\n  \"field_list\": \"lead_id,fname,lname,state_id,zip,phone\"\n}\n"},"url":"https://{{BaseAPI}}/api/lead/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Lead profile Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403781/Lead+Object\">Lead Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for leads associated with your account. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p><strong>NOTE: we HIGHLY recommend that you use the</strong> <strong><code>field_list</code></strong> <strong>argument to limit the fields that will be returned by this action.</strong></p>\n<p>Lead fields available for use in searches include:</p>\n<ul>\n<li><p><code>account_id</code></p>\n</li>\n<li><p><code>address1</code></p>\n</li>\n<li><p><code>appointment_id</code></p>\n</li>\n<li><p><code>b2bpartner_id</code></p>\n</li>\n<li><p><code>campaign_id</code></p>\n</li>\n<li><p><code>campaign_segment_id</code></p>\n</li>\n<li><p><code>carrier_id</code></p>\n</li>\n<li><p><code>county</code></p>\n</li>\n<li><p><code>deceased</code></p>\n</li>\n<li><p><code>deleted</code></p>\n</li>\n<li><p><code>disposition_date</code></p>\n</li>\n<li><p><code>dispo_id</code></p>\n</li>\n<li><p><code>dob</code></p>\n</li>\n<li><p><code>do_not_call</code></p>\n</li>\n<li><p><code>do_not_text</code></p>\n</li>\n<li><p><code>do_not_email</code></p>\n</li>\n<li><p><code>do_not_mail</code></p>\n</li>\n<li><p><code>email</code></p>\n</li>\n<li><p><code>fname</code></p>\n</li>\n<li><p><code>lead_date</code></p>\n</li>\n<li><p><code>lead_id</code></p>\n</li>\n<li><p><code>lead_type_id</code></p>\n</li>\n<li><p><code>lname</code></p>\n</li>\n<li><p><code>locked_by</code></p>\n</li>\n<li><p><code>phone</code></p>\n</li>\n<li><p><code>product_type_id</code></p>\n</li>\n<li><p><code>product_type_name</code></p>\n</li>\n<li><p><code>source_code</code></p>\n</li>\n<li><p><code>source_id</code></p>\n</li>\n<li><p><code>source_vendor_id</code></p>\n</li>\n<li><p><code>ssn</code></p>\n</li>\n<li><p><code>state_id</code></p>\n</li>\n<li><p><code>tag_id</code></p>\n</li>\n<li><p><code>user_id</code></p>\n</li>\n<li><p><code>zip</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","lead","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc306e60-8f8a-44b4-be46-3d6165489efd"},{"name":"Delete an Existing Lead","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"f390d709-423f-42bf-b7d1-104db1576ad2","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleOtherLeadID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Lead to delete in Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Delete an existing lead from the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleOtherLeadID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f390d709-423f-42bf-b7d1-104db1576ad2"},{"name":"Recover a Deleted Lead","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"697f5a06-39cd-4232-9a22-d22908e5528f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleOtherLeadID}}/undelete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for the deleted Lead you want to restore in Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Recover a Lead that was previously marked Deleted.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleOtherLeadID}}","undelete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"697f5a06-39cd-4232-9a22-d22908e5528f"},{"name":"Remove an Address","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"6e83643b-1153-4a94-a133-77866164a0cd","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/address/{{SampleLeadAddressID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>address_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for address record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing address from a lead profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","address","{{SampleLeadAddressID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e83643b-1153-4a94-a133-77866164a0cd"},{"name":"Remove a Phone","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"a8571af3-81d7-40ef-9146-e51c0c46dcdd","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/phone/{{SampleLeadPhoneID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>phone_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for phone record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing phone from a lead profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","phone","{{SampleLeadPhoneID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8571af3-81d7-40ef-9146-e51c0c46dcdd"},{"name":"Remove an Email Address","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"9ea48777-70af-41d1-b17c-6f2c6260c1ad","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/phone/{{SampleLeadEmailID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>email_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for email address record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing email address from a lead profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","phone","{{SampleLeadEmailID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ea48777-70af-41d1-b17c-6f2c6260c1ad"},{"name":"Remove a Notification Address","event":[{"listen":"test","script":{"id":"5f260c95-e24c-4d3b-b950-5f8882579646","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"4969c912-bbe0-48e1-b7f9-94e5a92b8293","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/leadNotificationAddress/{{SampleLeadNotificationAddressID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>lead_notification_address_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for notification address record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing notification address from a lead profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","leadNotificationAddress","{{SampleLeadNotificationAddressID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4969c912-bbe0-48e1-b7f9-94e5a92b8293"}],"id":"076e4ace-e5b8-44c2-b3e3-691687a628f1","description":"<p>Represents individual leads/contacts. All actions in the API are performed on behalf of a user record.</p>\n","_postman_id":"076e4ace-e5b8-44c2-b3e3-691687a628f1"},{"name":"Lead Vendor Setup - Lead Import Process","item":[{"name":"Lead Vendor Create","id":"f19d5296-4847-47a7-9d67-1ba8c9ef2343","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n     \"account_id\": \"12345\"\r\n    ,\"lead_vendor_id\":\"0\"\r\n    ,\"lead_vendor_code\":\"12345 default\"\r\n    ,\"parent_lead_vendor_id\":\"\"\r\n    ,\"company\":\"Partner Leads Inc.\"\r\n    ,\"rep_name\":\"Joe Doe\"\r\n    ,\"tech_name\":\"Bill Smith\"\r\n    ,\"delivery_lead_post\":\"1\"\r\n    ,\"delivery_email_file\":\"0\"\r\n    ,\"delivery_ftp_file\":\"0\"\r\n    ,\"demo\":\"\"\r\n    ,\"lead_vendor_date\":\"11/01/2022\"\r\n    ,\"last_lead_date\":\"\"\r\n    ,\"active\":\"1\"\r\n    ,\"rep_phone\": {\r\n        \"phone_type\": \"home\",\r\n        \"phone\": \"6667778888\",\r\n        \"phone_ext\": \"\"\r\n    }\r\n    ,\"rep_email\": {\r\n        \"email_type\": \"work\",\r\n        \"email\": \"rep@work.com\",\r\n        \"active\": \"true\"\r\n    }        \r\n    ,\"tech_phone\": {\r\n        \"phone_type\": \"home\",\r\n        \"phone\": \"2223334444\",\r\n        \"phone_ext\": \"123\"\r\n    }        \r\n    ,\"tech_email\": {\r\n        \"email_type\": \"work\",\r\n        \"email\": \"tech@work.com\",\r\n        \"active\": \"true\"\r\n    }\r\n}\r\n"},"url":"https://{{BaseAPI}}/api/leadVendor","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338248/LeadVendor+Object\">LeadVendor Object</a></td>\n<td>HTTP Body</td>\n<td>LeadVendor object to add to Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338248/LeadVendor+Object\">LeadVendor Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Creates a new Lead Vendor record. The following data is required for creating a Lead Vendor:</p>\n<ul>\n<li><p>lead_vendor_id - Enter 0 to create a new LeadVendor.</p>\n</li>\n<li><p>account_id - represents the LA Pro account the lead is going to.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","leadVendor"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f19d5296-4847-47a7-9d67-1ba8c9ef2343"},{"name":"Lead Vendor Generate a Secret Key","id":"c383299c-4332-4550-9321-75a520536d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}","type":"text"}],"url":"https://{{BaseAPI}}/api/leadVendor/{{LeadVendorID}}/generateLeadVendorKey","description":"<p>Creates a Secret Key for posting Leads without Authentication.</p>\n<ol>\n<li>Use the new {{LeadVendorID}} generated by the <strong>Lead Vendor Create</strong> endpoint and place it on the URL of the <strong>Lead Vendor Generate a Secret Key</strong> endpoint to generate the key.</li>\n<li>The generated secret key is sent to the email address(es) associated with the Lead Vendor.</li>\n<li>Go to <strong>Partner Lead - Post Lead w/o Authentication</strong> to continue with the Lead Posting process.</li>\n</ol>\n","urlObject":{"protocol":"https","path":["api","leadVendor","{{LeadVendorID}}","generateLeadVendorKey"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c383299c-4332-4550-9321-75a520536d2c"},{"name":"Partner Lead - Post Lead w/o Authentication","id":"293aafd5-d8c5-44d3-a513-000371362303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"lead_vendor_id","value":"{{lead_vendor_id}}","description":"<p>Refer to the  Lead Vendor Create endpoint. \nrequired for the import process</p>\n","type":"text"},{"key":"secret_key","value":"{{secret_key}}","type":"text","description":"<p>Refer to  the Lead Vendor Generate a Secret Key endpoint. \nrequired for the import process</p>\n"},{"key":"account_id","value":"{{account_id}}","type":"text","description":"<p>Represents the LA Pro account the lead is going to. \nrequired</p>\n"},{"key":"user_id","value":"{{user_id}}","type":"text","description":"<p>Represents a specific user within an account.\nProviding a user_id that does not exist within an account will simply create the lead as unassigned within the target account. \nrequired</p>\n"},{"key":"fname","value":"{{fname}}","type":"text","description":"<p>Lead's first name. \nrequired</p>\n"},{"key":"mname","value":"{{mname}}","type":"text","description":"<p>Lead's middle name</p>\n"},{"key":"lname","value":"{{lname}}","type":"text","description":"<p>Lead's last name. \nrequired</p>\n"},{"key":"title","value":"{{title}}","type":"text","description":"<p>Lead's title (Mr., Ms., Mrs., etc)</p>\n"},{"key":"gender","value":"{{gender}}","type":"text","description":"<p>Lead's gender (M, F)</p>\n"},{"key":"dob","value":"{{dob}}","type":"text","description":"<p>Lead's date of birth</p>\n"},{"key":"height","value":"{{height}}","type":"text","description":"<p>Lead's height in inches</p>\n"},{"key":"weight","value":"{{weight}}","type":"text","description":"<p>Lead's weight in pounds</p>\n"},{"key":"marital_status","value":"{{marital_status}}","type":"text","description":"<p>Lead's marital status (M=married, S=single, D=divorced, W=widowed)</p>\n"},{"key":"medicare_name","value":"{{medicare_name}}","type":"text","description":"<p>Lead's Medicare complete name</p>\n"},{"key":"medicare_parta_date","value":"{{medicare_parta_date}}","type":"text","description":"<p>Lead's Medicare part A date</p>\n"},{"key":"medicare_partb_date","value":"{{medicare_partb_date}}","type":"text","description":"<p>Lead's Medicare part B date</p>\n"},{"key":"tobacco","value":"{{tobacco}}","type":"text","description":"<p>Yes/No</p>\n"},{"key":"hicn","value":"{{hicn}}","type":"text","description":"<p>Health Insurance Claim Number</p>\n"},{"key":"ssn","value":"{{ssn}}","type":"text","description":"<p>Social Security Number</p>\n"},{"key":"product_type_id","value":"{{product_type_id}}","type":"text","description":"<p>Type of Product Types - See Product Types Enumeration endpoint. \nrequired</p>\n"},{"key":"lead_type_id","value":"{{lead_type_id}}","type":"text","description":"<p>Type of Lead Types - See Lead Types Enumeration endpoint</p>\n"},{"key":"address1","value":"{{address1}}","type":"text","description":"<p>Permanent address 1</p>\n"},{"key":"address2","value":"{{address2}}","type":"text","description":"<p>Permanent address 2</p>\n"},{"key":"city","value":"{{city}}","type":"text","description":"<p>Permanent city</p>\n"},{"key":"state_id","value":"{{state_id}}","type":"text","description":"<p>Permanent state</p>\n"},{"key":"zip","value":"{{zip}}","type":"text","description":"<p>Permanent zip code</p>\n"},{"key":"county","value":"{{county}}","type":"text","description":"<p>Permanent county</p>\n"},{"key":"phone","value":"{{phone}}","type":"text","description":"<p>10 digit phone number (NO FORMATTING)</p>\n"},{"key":"email","value":"{{email}}","type":"text","description":"<p>Email address</p>\n"},{"key":"note","value":"{{note}}","type":"text","description":"<p>Contents will be added as a Note conversation log item associated to the lead</p>\n"},{"key":"address_type","value":"{{address_type}}","type":"text","description":"<p>Type of Address - See Address Types Enumeration endpoint</p>\n"},{"key":"email_type","value":"{{email_type}}","type":"text","description":"<p>Type of Email Address - See Email Types Enumeration endpoint</p>\n"},{"key":"phone_type","value":"{{phone_type}}","type":"text","description":"<p>Type of Phone Number - See Phone Types Enumeration endpoint</p>\n"},{"key":"source_code","value":"{{source_code}}","type":"text","description":"<p>Tracking code associated with Lead Vendor Source. \nrequired</p>\n","disabled":true}]},"url":"https://{{BaseAPI}}/api/partners/lead/","description":"<p>Creates a partner lead without authentication using a secret key.</p>\n<p>The following data is required when posting a lead:</p>\n<ul>\n<li>lead_vendor_id - generated by the <strong>Lead Vendor Create</strong> endpoint.</li>\n<li>secret_key - generated by the <strong>Lead Vendor Generate Secret Key</strong> endpoint.</li>\n<li>account_id - represents the LA Pro account the lead is going to.</li>\n<li>user_id - providing a user_id that does not exist within an account will simply create the lead as unassigned within the target account.<ul>\n<li>note: not sending a user_id will post leads you will NOT have access to.</li>\n</ul>\n</li>\n<li>fname - required</li>\n<li>lname - required</li>\n<li>product_type_id - required</li>\n<li>source_code - required</li>\n</ul>\n<p>Use the <strong>View an Existing Lead</strong> and/or <strong>Update an Existing Lead</strong> endpoints to verify and/or update the posted data on your lead.</p>\n","urlObject":{"protocol":"https","path":["api","partners","lead",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"293aafd5-d8c5-44d3-a513-000371362303"}],"id":"f1c4722e-bd66-4e5e-974c-a60be62c1149","description":"<ul>\n<li>A Lead Vendor is what the Lead Advantage Pro (LA Pro) uses for tracking leads coming in from external sources.</li>\n<li>For setup, SMS requires Representative and Technical contact information for various communication purposes.<ul>\n<li><strong>Representative Contact</strong><ul>\n<li><strong>Name:</strong></li>\n<li><strong>Email:</strong></li>\n<li><strong>Phone:</strong></li>\n</ul>\n</li>\n<li><strong>Technical Contact</strong><ul>\n<li><strong>Name:</strong></li>\n<li><strong>Email:</strong></li>\n<li><strong>Phone:</strong></li>\n</ul>\n</li>\n</ul>\n</li>\n<li>SMS triggers a process that will send an email to the Technical contact with the necessary datapoints required in order to post leads to the LA Pro platform<ul>\n<li>Please contact your LA Pro technical representative if you have not been provided this information.</li>\n<li>The Lead Vendor will be use the provide a <strong>lead_vendor_id</strong> and a <strong>secret_key</strong> as part of the import process and are unique per environment (qa, production, etc.)<ul>\n<li><strong>QA (for testing)</strong><ul>\n<li><strong>lead_vendor_id:</strong></li>\n<li><strong>secret_key:</strong></li>\n</ul>\n</li>\n<li><strong>Production</strong><ul>\n<li><strong>lead_vendor_id:</strong></li>\n<li><strong>secret_key:</strong></li>\n</ul>\n</li>\n</ul>\n</li>\n<li>Please use the following default tracking_code if you have not been instructed by your clients on what to send<ul>\n<li><strong>source_code</strong>:</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n","_postman_id":"f1c4722e-bd66-4e5e-974c-a60be62c1149"},{"name":"Medical Providers","item":[{"name":"Search by ZIP or Lat/Long","event":[{"listen":"test","script":{"id":"49494ba6-fb19-4e0d-b3ab-5d4ce57e9632","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"20b273fa-a9d0-4bb2-95b5-555edf29a9a9","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"criteria\": {\r\n    \"zip\": \"22314\",\r\n    \"radius\": \"5\",\r\n    \"external_provider_name\":\"Arthur\",\r\n    \"external_provider_type_id\":\"1\",\r\n    \"network_id\":\"2018_H2108_028_000\"\r\n  },\r\n  \"page_number\": \"1\",\r\n  \"records_per_page\": \"20\",\r\n  \"orderby_field\":\"external_provider_name\",\r\n  \"orderby_direction\":\"desc\"\r\n}\r\n"},"url":"https://{{BaseAPI}}/api/ExternalProvider/search","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829686/Provider+Search+Criteria+Object\">Provider Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Provider Search Criteria</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054436478/External+Provider+Result+Objects\">External Provider Result Objects</a></p>\n<p>Perform a provider search. The body payload of this API request uses the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829686/Provider+Search+Criteria+Object\">Provider Search Criteria Object</a>.</p>\n<p>Provider search fields available for use in searches include:</p>\n<ul>\n<li><p><code>zip</code> or <code>latitude</code> + <code>longitude</code></p>\n</li>\n<li><p><code>radius</code></p>\n</li>\n<li><p><code>external_provider_name</code></p>\n</li>\n<li><p><code>external_provider_type_id</code></p>\n</li>\n<li><p><code>network_id</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","ExternalProvider","search"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"20b273fa-a9d0-4bb2-95b5-555edf29a9a9"},{"name":"Retrieve Details about Provider Office/Location(s)","event":[{"listen":"test","script":{"id":"32666371-aac3-416b-89bb-56fb13872b75","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"d2400920-ae2d-4f1c-99f3-ebf82dda8123","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"criteria\": {\n    \"external_provider_location_id\": {\n      \"type\": \"set\",\n      \"value\": [\"220008963\",\"-220000577\"]\n    },\n    \"external_provider_id\": {\n      \"type\": \"set\",\n      \"value\": [\"31767\",\"-220000577\"]\n    }\n  },\n  \"page_number\": \"1\",\n  \"records_per_page\": \"\",\n  \"orderby_field\":\"external_provider_name\",\n  \"orderby_direction\":\"desc\"\n}"},"url":"https://{{BaseAPI}}/api/ExternalProvider/search","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403794/Provider+Location+Search+Criteria+Object\">Provider Location Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Provider Location Search Criteria</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054436478/External+Provider+Result+Objects\">External Provider Result Objects</a></p>\n<p>Perform a provider search to return full provider location details when provider id and location id values are known. The body payload of this API request uses the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403794/Provider+Location+Search+Criteria+Object\">Provider Location Search Criteria Object</a>.</p>\n<p>The following provider search fields are required for this type of search:</p>\n<ul>\n<li><p><code>external_provider_location_id</code></p>\n</li>\n<li><p><code>external_provider_id</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","ExternalProvider","search"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2400920-ae2d-4f1c-99f3-ebf82dda8123"},{"name":"Determine if Provider is In Network for a given plan/location","event":[{"listen":"test","script":{"id":"ad3c6897-c611-4f6a-814b-fba66f2ceec0","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"8832aa57-e7b2-406b-9d39-a14e56161b06","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n  \"external_providers\": [{\r\n      \"external_provider_type_id\": \"1\",\r\n      \"external_provider_id\": \"3803844\"\r\n    },\r\n    {\r\n      \"external_provider_type_id\": \"2\",\r\n      \"external_provider_id\": \"-220000577\"\r\n    }\r\n  ],\r\n  \"network_id\": \"2018_H5521_027_000\"\r\n}"},"url":"https://{{BaseAPI}}/api/externalProvider/searchByProvider","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665933/Provider+Network+Search+Criteria+Object.\">Provider Network Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Provider Network Search Criteria</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054207128/External+Provider+Network+Result+Objects\">External Provider Network Result Objects</a></p>\n<p>Perform a provider network search to return all provider locations with an indicator of network participation. The body payload of this API request uses the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665933/Provider+Network+Search+Criteria+Object.\">Provider Network Search Criteria Object</a>.</p>\n<p>The following provider search fields are required for this type of search:</p>\n<ul>\n<li><p><code>external_providers</code></p>\n<ul>\n<li><p><code>external_provider_type_id</code></p>\n</li>\n<li><p><code>external_provider_id</code></p>\n</li>\n</ul>\n</li>\n<li><p><code>network_id</code></p>\n</li>\n</ul>\n<p>Each result will contain an \"in network\" flag to indicate network participation for the specified provider type.</p>\n","urlObject":{"protocol":"https","path":["api","externalProvider","searchByProvider"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8832aa57-e7b2-406b-9d39-a14e56161b06"}],"id":"01c63a44-bafa-463f-9196-41de9135f75a","description":"<p>The Lead Advantage Provider Lookup feature allow users to search for health care providers.</p>\n<p>This section lists the endpoints that can be used to perform a provider search by location, type, and network.</p>\n<p>The information returned in the Provider Lookup search results can then be used in a MAPD quote request to return information on provider participation in each plan quote result.</p>\n","_postman_id":"01c63a44-bafa-463f-9196-41de9135f75a"},{"name":"Medicine Cabinet & Drug Search","item":[{"name":"List Drug Names for Autosuggest","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"55f76a18-92ef-4dfa-8db1-def4f10aba66","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"drug_name\": \"Lip\"\r\n}"},"url":"https://{{BaseAPI}}/api/drug/getDrugNames","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829715/Drug+Name+Search+Object\">Drug Name Search Object</a></td>\n<td>HTTP Body</td>\n<td>Contains partial drug name to use as wildcard search for autosuggest feature(s)</td>\n</tr>\n<tr>\n<td>Returns: Array of Strings (Drug Names)</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for Drugs that contain the value entered into the <code>drug_name</code> field. This is a lightweight call that is meant to power a type-ahead, autosuggest interface.</p>\n<p><strong>Note: Our recommended best practice is to only perform the inital Autosuggest API call when the user has entered 3+ characters. For optimal efficiency, further character entries by the user should filter against the original API response instead of triggering new API calls to the autosuggest endpoint</strong></p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829715/Drug+Name+Search+Object\">Drug Name Search Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","drug","getDrugNames"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55f76a18-92ef-4dfa-8db1-def4f10aba66"},{"name":"Search for Drug Dosages by Drug Name","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"dbfd5c14-7c88-480d-8a57-8e298e0d4ffc","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"drug_name\": \"Lipitor\"\r\n}"},"url":"https://{{BaseAPI}}/api/drug/searchByDrugName","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829715/Drug+Name+Search+Object\">Drug Name Search Object</a></td>\n<td>HTTP Body</td>\n<td>Contains full or partial drug names to use in Drug Package search</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338285/Drug+Objects\">Drug Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for Drugs that contain the value entered into the <code>drug_name</code> field.</p>\n<p><strong>Note: The body payload of this API request uses a unique</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054829715/Drug+Name+Search+Object\">Drug Name Search Object</a><strong>, which differs from the standard Search Criteria Object used with other endpoints. See object detail for more information</strong></p>\n","urlObject":{"protocol":"https","path":["api","drug","searchByDrugName"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbfd5c14-7c88-480d-8a57-8e298e0d4ffc"},{"name":"Save a Drug to a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"2a554610-288e-420b-bb85-1e192b8258b4","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"drug_name\": \"Lipitor TAB 40MG\",\r\n    \"drug_base_name\": \"Lipitor\",\r\n    \"drug_type\": \"brand\",\r\n    \"drug_pack_size\": \"\",\r\n    \"drug_pack_type\": \"tab\",\r\n    \"drug_strength\": \"\",\r\n    \"drug_user_qty\": \"30\",\r\n    \"drug_freq\": \"30\",\r\n    \"drug_ndc_code\": \"00071015773\",\r\n    \"drug_external_id\": \"3243432\",\r\n    \"drug_dosage_external_id\": \"2323443\",\r\n    \"alternate_drug_name\": \"atorvastatin calcium\", \r\n\t\"alternate_drug_type\": \"generic\",              \r\n\t\"alternate_drug_ndc_code\": \"00002751001\",       \r\n\t\"alternate_drug_dosage_external_id\": \"34567\"\r\n}"},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Lead to associate Drug with</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912257/Lead+Drug+Object\">Lead Drug Object</a></td>\n<td>HTTP Body</td>\n<td>Provides Drug name and dosage (<code>drug_id</code> and <code>lead_id</code> are not required when using this endpoint)</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912257/Lead+Drug+Object\">Lead Drug Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Associates a drug with a Lead profile's medicine cabinet. The Lead ID of the profile to associate the drug with is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","drug",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a554610-288e-420b-bb85-1e192b8258b4"},{"name":"List Drugs Associated with a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"abd3aede-fce0-4a90-bdcd-e3235b35c962","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"search_type\": \"simple\",\r\n    \"criteria\": {\r\n        \"lead_id\": {\r\n          \"type\": \"simple\",\r\n          \"value\": [\"{{SampleLeadID}}\"]\r\n        }\r\n      },\r\n    \"orderby_field\":\"drug_id\",\r\n    \"orderby_direction\":\"asc\",\r\n    \"records_per_page\":\"10\",\r\n    \"page_number\":\"1\",\r\n    \"include_deleted\": \"false\",\r\n    \"field_list\": \"\"\r\n}\r\n"},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/search","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identfier for Lead for which you wish to find associated Drugs</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Lead-Drug relationship Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912257/Lead+Drug+Object\">Lead Drug Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for drugs that have been added to an existing Lead profile's medicine cabinet. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Lead-Drug Relationship fields available for searches include:</p>\n<ul>\n<li><p><code>drug_external_id</code></p>\n</li>\n<li><p><code>drug_id</code></p>\n</li>\n<li><p><code>drug_name</code></p>\n</li>\n<li><p><code>drug_ndc_code</code></p>\n</li>\n<li><p><code>drug_type</code></p>\n</li>\n<li><p><code>lead_id</code></p>\n</li>\n<li><p><code>quote_id</code></p>\n</li>\n</ul>\n<p>The Lead ID of the profile to search is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/search/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","drug","search"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"abd3aede-fce0-4a90-bdcd-e3235b35c962"},{"name":"Remove a Drug from a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"768c7421-188c-4b30-ac89-995a58b4fe7f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/{{SampleDrugID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>drug_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for the lead-drug relationship record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove a drug that has been added to a lead profile's medicine cabinet in the Lead Advantage system. The Lead ID of the profile to remove the drug from is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/drug/{{SampleDrugID}}/delete/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","drug","{{SampleDrugID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"768c7421-188c-4b30-ac89-995a58b4fe7f"}],"id":"0d094fe9-e783-4c9e-bf43-3c81f5444d69","description":"<p>The Lead Advantage Medicare Part D quote features allow users to provide specific drugs to retrieve cost information for.  this section lists the endpoints that allows users to search and select individual drugs to use in the Part D quote process.</p>\n","_postman_id":"0d094fe9-e783-4c9e-bf43-3c81f5444d69"},{"name":"Pharmacy Search","item":[{"name":"Search for Pharmacies by ZIP Code","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"147c1f10-e629-4df2-ac40-25f8ea222c74","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"zip\": \"{{AgentZIP}}\",\r\n    \"radius\": \"5\"\r\n}"},"url":"https://{{BaseAPI}}/api/pharmacy/searchByZip","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912269/ZIP+Radius+Object\">ZIP Radius Object</a></td>\n<td>HTTP Body</td>\n<td>Allows you to specify the search location (zip) and radius (in miles)</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054502105/Pharmacy+Search+Result+Objects\">Pharmacy Search Result Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Perform a ZIP code/Radius search for pharmacies in the Lead Advantage system.</p>\n<p><strong>Note: Geographic ZIP/Radius searches are performed from the lat/long center point of a ZIP code. We recommend using a minimum radius of 3-5 miles when performing searches.</strong></p>\n","urlObject":{"protocol":"https","path":["api","pharmacy","searchByZip"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"147c1f10-e629-4df2-ac40-25f8ea222c74"},{"name":"Save a Pharmacy to a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"81f615ff-0ac0-4d9d-b755-0fce628c6ae6","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"pharmacy_external_id\":\"{{PharmacyExternalID}}\",\r\n  \"pharmacy_name\":\"{{PharmacyName}}\",\r\n  \"address\": {\r\n    \"address_type_id\": \"business\",\r\n    \"address1\": \"245 NORTH BROAD STREET\",\r\n    \"address2\": \"Suite 223\",\r\n    \"city\": \"PHILADELPHIA\",\r\n    \"state_id\": \"PA\",\r\n    \"zip\":\"19107\"\r\n  }\r\n}    "},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for Lead to associate Pharmacy with</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633112/Lead+Pharmacy+Object\">Lead Pharmacy Object</a></td>\n<td>HTTP Body</td>\n<td>Provides Pharmacy name and physical address (<code>pharmacy_id</code> and <code>lead_id</code> are not required when using this endpoint)</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633112/Lead+Pharmacy+Object\">Lead Pharmacy Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Associates a physical pharmacy with a Lead profile. The Lead ID of the profile to associate the pharmacy with is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","pharmacy",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81f615ff-0ac0-4d9d-b755-0fce628c6ae6"},{"name":"List Pharmacies Associated with a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"948e7041-078e-4637-b45d-e091d238345e","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"lead_id\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"{{SampleLeadID}}\"]\r\n    }\r\n  },\r\n  \"field_list\": \"\"\r\n}"},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/search","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identfier for Lead for which you wish to find associated Pharmacies</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>Lead-Pharmacy relationship Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054633112/Lead+Pharmacy+Object\">Lead Pharmacy Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for pharmacies that have been associated with an existing Lead profile. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>Lead-Pharmacy Relationship fields available for searches include:</p>\n<ul>\n<li><p><code>address1</code></p>\n</li>\n<li><p><code>city</code></p>\n</li>\n<li><p><code>lead_id</code></p>\n</li>\n<li><p><code>pharmacy_external_id</code></p>\n</li>\n<li><p><code>pharmacy_id</code></p>\n</li>\n<li><p><code>pharmacy_name</code></p>\n</li>\n<li><p><code>quote_id</code></p>\n</li>\n<li><p><code>state_id</code></p>\n</li>\n<li><p><code>zip</code></p>\n</li>\n</ul>\n<p>The Lead ID of the profile to search is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/search/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","pharmacy","search"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"948e7041-078e-4637-b45d-e091d238345e"},{"name":"Remove a Pharmacy from a Lead Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"4c1e733b-3a39-4efc-a49a-ff66255f0f53","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/{{SamplePharmacyID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lead_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for Lead profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>pharmacy_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for the lead-pharmacy relationship record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove a pharmacy that has been saved to a lead profile in the Lead Advantage system. The Lead ID of the profile to remove the Pharmacy from is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SampleLeadID}}/pharmacy/{{SamplePharmacyID}}/delete/)</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SampleLeadID}}","pharmacy","{{SamplePharmacyID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c1e733b-3a39-4efc-a49a-ff66255f0f53"}],"id":"9053450c-e51e-4524-a798-8f28a30dcf19","description":"<p>The Lead Advantage Medicare Part D quote features allow users to indicate specific pharmacies to retrieve cost information for.  This section lists the endpoints that allow users to search and select individual pharamcies to use in the Part D quote process.</p>\n<p><strong>Note: While the API currently allows you to associated multipe pharmacies with a single Lead profile, we have not yet rolled out the quoting functionality to support quoting multiple pharmacies at once.  For now, please limit one pharmacy per Lead profile</strong>  </p>\n","_postman_id":"9053450c-e51e-4524-a798-8f28a30dcf19"},{"name":"Plan","item":[{"name":"View a Plan Overview","event":[{"listen":"test","script":{"id":"58b222b0-5966-48a5-bb03-4020908d69d9","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"6da7bd60-e03b-4f41-8fa3-cc577f2d4bf9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SamplePlanID}}/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>plan_id</td>\n<td>string</td>\n<td>Path</td>\n<td>Identifier for Plan to retrieve.  <br />  <br />Note that the plan_id must be in the format [Plan Year]_[Contract ID]_[CMS Plan ID]_[Segment_id] where the Segment ID is three characters. It may be neccessary to add leading zeroes to the Segment ID.  <br />  <br />EX: 2025_H5216_427_004</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403751/Plan+Object\">Plan Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve a plan record stored in Lead Advantage. The Plan ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SamplePlanID}})</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SamplePlanID}}",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6da7bd60-e03b-4f41-8fa3-cc577f2d4bf9"},{"name":"View a Plan in Detail","event":[{"listen":"test","script":{"id":"c03f2a02-9c87-4fdd-9254-001de8fe0afd","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript","packages":{}}}],"id":"e6059358-0871-4983-b760-6e8f9d89898f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/lead/{{SamplePlanID}}/detail","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>plan_id</td>\n<td>string</td>\n<td>Path</td>\n<td>Identifier for Plan to retrieve.  <br />  <br />Note that the plan_id must be in the format [Plan Year]_[Contract ID]_[CMS Plan ID]_[Segment_id] where the Segment ID is three characters. It may be neccessary to add leading zeroes to the Segment ID.  <br />  <br />EX: 2025_H5216_427_004</td>\n</tr>\n<tr>\n<td>Returns: Plan Detail structure serialized as JSON.  <br />Note that Plan Detail formats can vary widely from between product types, carriers, and even plans from the same carrier.</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve a plan record stored in Lead Advantage. The Plan ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/lead/{{SamplePlanID}})</p>\n","urlObject":{"protocol":"https","path":["api","lead","{{SamplePlanID}}","detail"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6059358-0871-4983-b760-6e8f9d89898f"}],"id":"ca07b0fa-f1a7-4c24-93f6-a4aafababa1d","_postman_id":"ca07b0fa-f1a7-4c24-93f6-a4aafababa1d","description":""},{"name":"Product Filter","item":[{"name":"View Product Filter","event":[{"listen":"test","script":{"id":"61c28ad9-a123-4ef8-bca3-9d44a532c3e7","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"9b1da800-dd05-42d5-9470-f422454ced6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"url":"https://{{BaseAPI}}.leadadvantagepro.com/api/productFilter/2019/","description":"<p>View an existing Product Filter record.\nThe following is the enumeration of the available filter levels:\n1 = Product Type (MA, Medsup, PDP, etc.)</p>\n<p>2 = Carrier</p>\n<p>3 = Plan Year</p>\n<p>4 = Plan</p>\n<p>5 = State</p>\n","urlObject":{"protocol":"https","path":["api","productFilter","2019",""],"host":["{{BaseAPI}}","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b1da800-dd05-42d5-9470-f422454ced6c"},{"name":"Product Filter Edit - Create","event":[{"listen":"test","script":{"id":"7f4f1aad-f66b-4828-99dc-06acb7931745","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"f0a9b773-d708-4a56-be28-08bea2717803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"body":{"mode":"raw","raw":"{\r\n  \"user_id\":\"8802\"\r\n  ,\"account_id\":\"10980\"\r\n  ,\"filter_level\":\"2\"\r\n  ,\"product_type_id\":\"7\"\r\n  ,\"carrier_id\":\"2381\"\r\n  ,\"plan_id\":\"\"\r\n  ,\"plan_name\":\"\"\r\n}"},"url":"https://{{BaseAPI}}.leadadvantagepro.com/api/productFilter/","description":"<p>Create a new product filter record.</p>\n<p>The following is the enumeration of the available filter levels:\n1 = Product Type (MA, Medsup, PDP, etc.)</p>\n<p>2 = Carrier</p>\n<p>3 = Plan Year</p>\n<p>4 = Plan</p>\n<p>5 = State</p>\n","urlObject":{"protocol":"https","path":["api","productFilter",""],"host":["{{BaseAPI}}","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0a9b773-d708-4a56-be28-08bea2717803"},{"name":"Product Filter Edit - Existing","event":[{"listen":"test","script":{"id":"71c2de62-2208-4c11-b275-98f8d968d64f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"abcea385-514e-4ee7-8a27-713794b36488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"body":{"mode":"raw","raw":"{\r\n  \"user_id\":\"8802\"\r\n  ,\"account_id\":\"10979\"\r\n  ,\"filter_level\":\"2\"\r\n  ,\"product_type_id\":\"7\"\r\n  ,\"carrier_id\":\"2381\"\r\n  ,\"plan_id\":\"\"\r\n  ,\"plan_name\":\"\"\r\n}"},"url":"https://{{BaseAPI}}.leadadvantagepro.com/api/productFilter/2019","description":"<p>Update an existing Product Filter record.</p>\n","urlObject":{"protocol":"https","path":["api","productFilter","2019"],"host":["{{BaseAPI}}","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"abcea385-514e-4ee7-8a27-713794b36488"},{"name":"Product Filter Search - Simple","event":[{"listen":"test","script":{"id":"077cd76b-74b2-445b-a818-9b6947321f47","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"8152b700-a628-4f0f-a5b3-d4b0ac8c73cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"account_id\": {\r\n      \"type\": \"range\",\r\n      \"value\": [1, 10980]\r\n    },\r\n    \"product_type_id\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"7\"]\r\n    }\r\n  },\r\n  \"field_list\": \"\"\r\n}"},"url":"https://{{BaseAPI}}.leadadvantagepro.com/api/productFilter/search/","description":"<p>Perform a simple search for records.</p>\n","urlObject":{"protocol":"https","path":["api","productFilter","search",""],"host":["{{BaseAPI}}","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8152b700-a628-4f0f-a5b3-d4b0ac8c73cf"},{"name":"Product Filter Delete","event":[{"listen":"test","script":{"id":"3ce35764-7441-42f4-aebb-f93e399c0024","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"b2569adb-3e46-4412-af1e-de165dea186c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{LAPro_AccessToken_Default}}"}],"url":"https://{{BaseAPI}}.leadadvantagepro.com/api/productFilter/1397/delete/","description":"<p>Delete a specific product filter record.</p>\n","urlObject":{"protocol":"https","path":["api","productFilter","1397","delete",""],"host":["{{BaseAPI}}","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2569adb-3e46-4412-af1e-de165dea186c"}],"id":"0e00d022-8561-43a5-915d-45f2fef284f3","description":"<p>This feature allows filtering of product results in quoting by limiting items by product line type, carrier(s) and/or plan(s).  These filters can be applied at the account level or defined by specific users.</p>\n<p>The following is the enumeration of the available filter levels:\n1 = Product Type (MA, Medsup, PDP, etc.)</p>\n<p>2 = Carrier</p>\n<p>3 = Plan Year</p>\n<p>4 = Plan</p>\n<p>5 = State</p>\n","event":[{"listen":"prerequest","script":{"id":"8142d691-6bb9-45b8-b244-52e32d0a3bfe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2064ced1-1c18-4479-b6b4-4290bd316e79","type":"text/javascript","exec":[""]}}],"_postman_id":"0e00d022-8561-43a5-915d-45f2fef284f3"},{"name":"Quoting - Final Expense","item":[{"name":"Request a Final Expense Quote","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"a180c12d-1f03-4483-a3f8-01f874f7e7a6","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"dob\": \"1950-12-01\",\r\n  \"zip\": \"22314\",\r\n  \"gender\": \"F\",\r\n  \"tobacco\": \"false\",\r\n  \"fex_face_amount\": \"10000\",\r\n  \"fex_plan_type\": \"level\",\r\n  \"quote_products\": {\r\n    \"fex\": \"true\"\r\n  }\r\n}"},"url":"https://{{BaseAPI}}/api/quote/QuoteRequest","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a></td>\n<td>HTTP Body</td>\n<td>Defines criteria to use in quote action</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Response Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Requests a Final Expense quote from the Lead Advantage system</p>\n<p><strong>Note: The Lead Advantage system uses a single Quote Request object for all quote actions, use the guide in</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a> <strong>to determine what fields are applicable and required for each product type</strong></p>\n","urlObject":{"protocol":"https","path":["api","quote","QuoteRequest"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a180c12d-1f03-4483-a3f8-01f874f7e7a6"}],"id":"0c210ef5-a2c5-478b-84b0-ea171f2aebc8","description":"<p>This section lists the endpoints related to obtaining quotes for the Final Expense Life Insurance products in the Lead Advantage system</p>\n","_postman_id":"0c210ef5-a2c5-478b-84b0-ea171f2aebc8"},{"name":"Quoting - MA & PDP","item":[{"name":"Request an MA and/or PDP Quote","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"dcb211de-df76-4c59-b0ba-27cfd919d2fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"2a10oAyx4uGzL5px2YemEufYNuYLXe6SsKsJEjxlkHpIPJW9iF"}],"body":{"mode":"raw","raw":"{\r\n  \"eff_date\": \"03/01/2024\",\r\n  \"gender\": \"F\",\r\n  \"dob\": \"1950-12-01\",\r\n  \"zip\": \"22314\",\r\n  \"county\": \"ALEXANDRIA CITY\",\r\n  \"quote_products\": {\r\n    \"ma\": \"true\",\r\n    \"partd\": \"true\"\r\n  },\r\n  \"health_status\": \"Good\",\r\n  \"pharmacy_id\": \"\",\r\n  \"drugs\": [{\r\n    \"drug_pack_size\": \"1\",\r\n    \"drug_pack_type\": \"Vial\",\r\n    \"drug_strength\": \"20\",\r\n    \"drug_user_qty\": \"1\",\r\n    \"drug_freq\": \"30\",\r\n    \"drug_name\": \"Abelcet INJ 5MG/ML - 20 ML Vial\",\r\n    \"drug_ndc_code\": \"57665010141\"\r\n  }, {\r\n    \"drug_pack_size\": \"1\",\r\n    \"drug_pack_type\": \"Vial\",\r\n    \"drug_strength\": \"10\",\r\n    \"drug_user_qty\": \"1\",\r\n    \"drug_freq\": \"30\",\r\n    \"drug_name\": \"Humalog INJ 100/ML - 10 ML Vial\",\r\n    \"drug_ndc_code\": \"00002751001\"\r\n  }],\r\n  \"external_providers\": [\r\n    {\r\n      \"external_provider_type_id\": \"1\",\r\n      \"external_provider_id\": \"3803844\",\r\n      \"external_provider_location_id\": \"200281781\"\r\n    },\r\n    {\r\n      \"external_provider_type_id\": \"2\",\r\n      \"external_provider_id\": \"-220000577\",\r\n      \"external_provider_location_id\": \"-220000577\"\r\n    }\r\n  ]\r\n}"},"url":"https://{{BaseAPI}}/api/quote/QuoteRequest","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a></td>\n<td>HTTP Body</td>\n<td>Defines criteria to use in quote action</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Response Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Requests a quote for Medicare Advantage and/or Medicare Part D from the Lead Advantage system</p>\n<p><strong>Note: The Lead Advantage system uses a single Quote Request object for all quote actions, use the guide in</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a> <strong>to determine what fields are applicable and required for each product type</strong></p>\n","urlObject":{"protocol":"https","path":["api","quote","QuoteRequest"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcb211de-df76-4c59-b0ba-27cfd919d2fc"},{"name":"Get MA and/or PDP Plan Details","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"91eef3ec-2bae-4ff2-83be-0d2e58fc2120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"product_type\":\"mapd\"\r\n\t,\"drx_session_id\":\"{{SampleDRXSessionID}}\"\r\n\t,\"effective_date\":\"2024-04-01\"\r\n\t,\"zip\":\"44438\"\r\n\t,\"county\":\"Trumbull\"\r\n\t,\"health_status\":\"Good\"\r\n\t,\"pharmacy_id\":\"NQ14Y\"\r\n\t,\"show_default_pharmacy_pricing\":true\r\n\r\n\t,\"plan_info\":{\r\n\t\t\"company\":\"Anthem Blue Cross and Blue Shield (OH)\"\r\n\t\t,\"company_id\":\"anthemoh\"\r\n\t\t,\"drxplan_id\":\"1KYYZBDYTZ\"\r\n\t\t,\"plan_id\":\"2023_R5941_013_000\"\r\n\t\t,\"plan_name\":\"Anthem MediBlue Access Core (Regional PPO)\"\r\n\t\t,\"annual_premium\":\"0.0\"\r\n\t}\r\n\r\n\t,\"drugs\":[\r\n\t\t{\r\n\t\t\t\"drug_pack_size\": \"1\",\r\n\t\t\t\"drug_pack_type\": \"Vial\",\r\n\t\t\t\"drug_strength\": \"20\",\r\n\t\t\t\"drug_user_qty\": \"1\",\r\n\t\t\t\"drug_freq\": \"30\",\r\n\t\t\t\"drug_name\": \"Abelcet INJ 5MG/ML - 20 ML Vial\",\r\n\t\t\t\"drug_ndc_code\": \"57665010141\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://{{BaseAPI}}/api/quote/PlanDetail","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3229646855/MAPD+Plan+Details+Request+Object\">MAPD Plan Details Request Object</a></td>\n<td>HTTP Body</td>\n<td>Specifies a Medicare Advantage or Part D plan for which to retrive benefit information details.</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3229810699/Array+of+MAPD+Plan+Details+Response+Objects\">Array of MAPD Plan Details Response Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieves benefit information details for one Medicare Advantage and/or Medicare Part D plan from the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","quote","PlanDetail"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91eef3ec-2bae-4ff2-83be-0d2e58fc2120"},{"name":"Email Part D Quotes to Client","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"597502fd-cc74-4717-b453-702d0de5d64b","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"draft\":\"0\",\r\n  \"lead_id\": \"{{SampleLeadID}}\",\r\n  \"user_id\": \"{{AgentUserID}}\",\r\n  \"user_carrier_id\": \"{{AgentUserCarrierID}}\",\r\n  \"plan_id\": \"2017_S5810_041_000\",\r\n  \"plan_name\": \"Aetna Medicare Rx Saver (PDP) S5810-041\",\r\n  \"client_name\": \"Bob Cliente\",\r\n  \"client_email\": \"{{SampleLeadEmail}}\",\r\n  \"client_dob\": \"1950-12-01\",\r\n  \"client_zip\": \"22314\",\r\n  \"process_type\": \"EmailQuote\",\r\n  \"external_redirect_url\": \"\",\r\n  \"notify_web_hook_url\": \"\",\r\n  \"alert_notice\": \"0\",\r\n  \"alert_email\": \"1\",\r\n  \"email_quote_result\": {\r\n\r\n\t  \"drugs\": [\r\n\t\t{\r\n\t\t  \"drug_id\": \"598\",\r\n\t\t  \"lead_id\": \"11678\",\r\n\t\t  \"drug_name\": \"Lipitor TAB 40MG\",\r\n\t\t  \"drug_base_name\": \"Lipitor\",\r\n\t\t  \"drug_type\": \"brand\",\r\n\t\t  \"drug_pack_size\": \"\",\r\n\t\t  \"drug_pack_type\": \"tab\",\r\n\t\t  \"drug_strength\": \"\",\r\n\t\t  \"drug_user_qty\": \"30\",\r\n\t\t  \"drug_freq\": \"30\",\r\n\t\t  \"drug_ndc_code\": \"00071015773\",\r\n\t\t  \"drug_external_id\": \"3243432\",\r\n\t\t  \"drug_dosage_external_id\": \"2323443\"\r\n\t\t}\r\n\t  ],\r\n\t  \r\n\t  \"mapd_plan_quote_results\": [\r\n\t\t{\r\n\t\t  \"plan_id\": \"2017_S5810_041_000\",\r\n\t\t  \"plan_name\": \"Aetna Medicare Rx Saver (PDP)\",\r\n\t\t  \"drx_plan_name\": \"Aetna Medicare Rx Saver (PDP) S5810-041\",\r\n\t\t  \"drxplan_id\": \"19RMJDYLPB\",\r\n          \"mapd_product_type\": \"PDP\",\r\n\t\t  \"plan_year\": \"2017\",\r\n\t\t  \"contract_id\": \"S5810\",\r\n\t\t  \"plan_code\": \"041\",\r\n\t\t  \"segment_id\": \"000\",\r\n\t\t  \"plan_type\": \"Basic\",\r\n\t\t  \"product_type_id\": \"11\",\r\n\t\t  \"app_by_email\": \"1\",\r\n\t\t  \"medical_premium\": \"0.0\",\r\n\t\t  \"coverage\": false,\r\n\t\t  \"estimated_drug_costs_partial_year\": \"2651.94\",\r\n\t\t  \"sms_enrollment_url\": \"\",\r\n\t\t  \"organization\": \"Aetna Medicare\",\r\n\t\t  \"medical_deductible\": \"0.0\",\r\n\t\t  \"estimated_medical_costs_partial_year\": \"0.0\",\r\n\t\t  \"drug_deductible\": \"360.0\",\r\n\t\t  \"estimated_medical_costs_order\": \"0.0\",\r\n\t\t  \"drx_enrollment_url\": \"https://www.drxwebservices.com/APIPlanCompare/v1/Session/MY6KPTK6A/Plans/19RMJDYLPB/Enroll\",\r\n\t\t  \"company_id\": \"aetna\",\r\n\t\t  \"specialist\": \"\",\r\n\t\t  \"sms_plan_name\": \"Aetna Medicare Rx Saver (PDP)\",\r\n\t\t  \"annual_total_combined\": \"5033.88\",\r\n\t\t  \"annual_total_medical\": \"382.8\",\r\n\t\t  \"moop\": \"$0.00\",\r\n\t\t  \"estimated_drug_costs\": \"4651.08\",\r\n\t\t  \"plan_rating\": \"3.5\",\r\n\t\t  \"estimated_medical_costs\": \"0.0\",\r\n\t\t  \"annual_total_drug\": \"5033.88\",\r\n\t\t  \"estimated_drug_costs_order\": \"4651.08\",\r\n\t\t  \"annual_premium\": \"382.79999999999995\",\r\n\t\t  \"drug_premium\": \"31.9\",\r\n\t\t  \"hospital\": \"\",\r\n\t\t  \"source\": \"drx\",\r\n\t\t  \"special_needs\": \"0\",\r\n\t\t  \"pcp\": \"\",\r\n\t\t  \"web_app\": \"1\",\r\n\t\t  \"summarypdf\": \"http://www.example.com/summary/2017_S5810_041_000.pdf\",    \r\n\t\t  \"enrollment_types\": []\r\n\t\t}\r\n\t\t\r\n\t]\r\n  }\r\n}\r\n\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054502134/Email+Quote+Result+Object\">Email Quote Result Object</a> payload</td>\n<td>HTTP Body</td>\n<td>Includes information needed to generate a client invitation email to provide secure access to Part D quote information</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a> with populated <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054502134/Email+Quote+Result+Object\">Email Quote Result Object</a> information</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>NOTE: Keep track of the</strong> <strong><code>client_invite_id</code></strong> <strong>value generated by this call - you will use it to check for status updates for this Part D Quote Client Invitation</strong></p>\n<p>Generates a Client Invitation populated with the quote information selected from the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054338327/Part+D+Quote+Response+Object\">Part D Quote Response Objects</a>. This sends an email to the client with an invitation link to view quotes for their User-selected plans in a secure environment.</p>\n","urlObject":{"protocol":"https","path":["api","clientInvite",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"597502fd-cc74-4717-b453-702d0de5d64b"},{"name":"Check Quote Email Client Invitation Status","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"b3bc5d86-7b08-49da-8739-49fd228dd6fa","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"\r\n"},"url":"https://{{BaseAPI}}/api/clientInvite/{{ClientInviteEmailQuoteID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>client_invite_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifies the Part D Quote Client Invitation to retrieve client access information for</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieves an updated Part D Quote Client Invitation record. If a Client has interacted with the invitation, client access date times will be stamped in <code>client_first_visit_date</code> and <code>client_last_visit_date</code> properties of the <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054796854/Client+Invite+Object\">Client Invite Object</a></p>\n","urlObject":{"protocol":"https","path":["api","clientInvite","{{ClientInviteEmailQuoteID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3bc5d86-7b08-49da-8739-49fd228dd6fa"}],"id":"239b77a3-97a8-4fe5-b400-31329b82e04e","description":"<p>This section lists the endpoints related to obtaining quotes for the Medicare Advantage and Medicare Part D products in the Lead Advantage system</p>\n","_postman_id":"239b77a3-97a8-4fe5-b400-31329b82e04e"},{"name":"Quoting - Medicare Supplement","item":[{"name":"Request a Medicare Supplement Quote","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"2b90bef4-c39d-4e94-ad14-ca658ddde74c","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"eff_date\": \"2019-09-01\",\r\n  \"dob\": \"1950-12-01\",\r\n  \"zip\": \"22314\",\r\n  \"county\": \"ALEXANDRIA CITY\",\r\n  \"part_a_date\":\"2019-09-01\r\n  \"part_b_date\":\"2019-09-01\",\r\n  \"household_discount\":\"true\",\r\n  \"OEGI\": \"OE\",\r\n  \"tobacco\": \"false\",\r\n  \"gender\": \"F\",\r\n  \"quote_products\": {\r\n    \"medsup\": \"true\"\r\n  }\r\n}"},"url":"https://{{BaseAPI}}/api/quote/QuoteRequest","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a></td>\n<td>HTTP Body</td>\n<td>Defines criteria to use in quote action</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054305415/Quote+Response+Object\">Quote Response Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Requests a Medicare Supplement quote from the Lead Advantage system</p>\n<p><strong>Note: The Lead Advantage system uses a single Quote Request object for all quote actions, use the guide in</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054469249/Quote+Request+Object\">Quote Request Object</a> <strong>to determine what fields are applicable and required for each product type</strong></p>\n","urlObject":{"protocol":"https","path":["api","quote","QuoteRequest"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b90bef4-c39d-4e94-ad14-ca658ddde74c"}],"id":"c14d8785-7dd8-49e2-b012-4e8fbc147d04","description":"<p>This section lists the endpoints related to obtaining quotes for the Medicare Supplement products in the Lead Advantage system</p>\n","_postman_id":"c14d8785-7dd8-49e2-b012-4e8fbc147d04"},{"name":"User","item":[{"name":"View an Existing User Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"05cc634d-9006-4e21-9bbc-9b39e3c48111","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/user/{{AgentUserID}}/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for User profile to retrieve</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Retrieve the current information in an agent/user profile in Lead Advantage. The User ID of the record to retrieve is passed in the URL path (e.g. {{BaseAPI}}/api/user/{{AgentUserID}})</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentUserID}}",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05cc634d-9006-4e21-9bbc-9b39e3c48111"},{"name":"Create a New User Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AgentOtherUserID\", data.user_id);","postman.setEnvironmentVariable(\"AgentOtherUserAddressID\", data.default_address.address_id);","postman.setEnvironmentVariable(\"AgentOtherUserEmailID\", data.default_email.email_id);","postman.setEnvironmentVariable(\"AgentOtherUserPhoneID\", data.default_phone.phone_id);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"d177fb35-cc30-40e7-8c6f-37d206060206","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"npn\": \"123456789\",\r\n    \"company\": \"Acme Insurance, Inc.\",\r\n    \"ein\": \"\",\r\n    \"fname\": \"Tester\",\r\n    \"lname\": \"Smith\",\r\n    \"gender\": \"m\",\r\n    \"dob\": \"1/1/1971\",\r\n    \"account_id\": \"{{AgentAccountID}}\",\r\n    \"role_id\": \"{{AgentRoleID}}\",\r\n    \"userCredentials\": [\r\n        {\r\n          \"context\": \"{{APIPartnerLoginContext}}\",\r\n          \"login\": \"{{AgentOtherUsername}}\",\r\n          \"password\": \"{{AgentOtherPassword}}\"\r\n        }\r\n    ],\r\n    \"registration_date\": \"2017-05-01\",\r\n    \"addresses\": [\r\n        {\r\n            \"address_type_id\": \"business\",\r\n            \"address1\": \"123 Test Ln\",\r\n            \"address2\": \"\",\r\n            \"city\": \"Omaha\",\r\n            \"state_id\": \"NE\",\r\n            \"default_address\":\"true\"\r\n        }\r\n    ],\r\n    \"emails\": [\r\n        {\r\n            \"email_type\": \"work\",\r\n            \"email\": \"tester@example.com\",\r\n            \"default_email\": \"true\"\r\n        }\r\n    ],\r\n    \"phones\": [\r\n        {\r\n            \"phone_type\": \"work\",\r\n            \"phone\": \"5555555555\",\r\n            \"phone_ext\": \"\",\r\n            \"default_phone\":\"true\"\r\n        }\r\n    ]\r\n}"},"url":"https://{{BaseAPI}}/api/user/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Object</a></td>\n<td>HTTP Body</td>\n<td>User object to add to Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Create a new user profile. The following data is required for all users:</p>\n<ul>\n<li><p>company - User's business name</p>\n</li>\n<li><p>fname - User's first name</p>\n</li>\n<li><p>lname - User's last name</p>\n</li>\n<li><p>emails - User's email address(es)</p>\n</li>\n<li><p>phone - User's phone number(s)</p>\n</li>\n<li><p>addresses.state_id - User's resident address state</p>\n</li>\n<li><p>userCredentials - User's authorization details (see <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912315/User+Credentials+Object\">User Credentials Object</a>). <strong>Note: the userCredential field is only required when creating a new user</strong></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","user",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d177fb35-cc30-40e7-8c6f-37d206060206"},{"name":"Update an Existing User Profile","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"AgentOtherUserID\", data.user_id);","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"60278f48-1975-43c2-8f8a-6dfcb9e3a31e","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n    \"fname\": \"Testessa\",\r\n    \"lname\": \"Smith\",\r\n    \"gender\": \"f\",\r\n    \"dob\": \"1975-01-01\"\r\n}"},"url":"https://{{BaseAPI}}/api/user/{{AgentOtherUserID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for existing User profile to update</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Object</a></td>\n<td>HTTP Body</td>\n<td>User Object containing fields to update in existing Lead profile</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Update the information stored in an existing User Profile. The User ID of the record to update is included in the URL Path (e.g. {{BaseAPI}}/api/user/{{AgentOtherUserID}}) You can provide a complete <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Object</a> to update all fields in the user profile, or you can provide a partial collection of only those fields you would like to update in the profile.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentOtherUserID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60278f48-1975-43c2-8f8a-6dfcb9e3a31e"},{"name":"List Writing Numbers on File for a User","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"dce7845f-e203-43c7-b974-e6c42d50bdf8","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"user_id\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\r\n        \"{{AgentUserID}}\"\r\n      ]\r\n    }\r\n  },\r\n  \"field_list\": \"\"\r\n}"},"url":"https://api.leadadvantagepro.com/api/usercarrier/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>User Carrier Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054731405/User+Carrier+Objects\">User Carrier Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for Agent Writing Numbers (AWNs) on file with the Lead Advantage system. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n<p>User Carrier fields available for use in searches include:</p>\n<ul>\n<li><p><code>user_id</code></p>\n</li>\n<li><p><code>carrier_id</code></p>\n</li>\n<li><p><code>agent_writing_number</code></p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","usercarrier","search",""],"host":["api","leadadvantagepro","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dce7845f-e203-43c7-b974-e6c42d50bdf8"},{"name":"Search for User Profiles","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"682fd2d3-295b-4f03-87e4-54d4b60bd61e","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n  \"search_type\": \"simple\",\n  \"criteria\": \n    {\n      \"account_id\":{\n      \"type\":\"simple\",\n      \"value\":[\"{{AgentAccountID}}\"]\n      }\n    },\n  \"field_list\": \"\"\n}\n"},"url":"https://{{BaseAPI}}/api/user/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>User profile Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054370993/User+object\">User Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Search for users associated with your account. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n","urlObject":{"protocol":"https","path":["api","user","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"682fd2d3-295b-4f03-87e4-54d4b60bd61e"},{"name":"Credentials - List User's Logins","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c0c32497-d3ec-47cc-b547-663d3bcb37e1","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\r\n  \"search_type\": \"simple\",\r\n  \"criteria\": {\r\n    \"user_id\": {\r\n      \"type\": \"simple\",\r\n      \"value\": [\"{{AgentUserID}}\"]\r\n    }\r\n  },\r\n  \"field_list\": \"\"\r\n}"},"url":"https://{{BaseAPI}}/api/user/{{AgentUserID}}/userCredentials/search/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for User whose credentials records you are searching</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a></td>\n<td>HTTP Body</td>\n<td>User Credentials Search Criteria</td>\n</tr>\n<tr>\n<td>Returns: Array of <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912332/User+Credentials+Search+Result+Objects\">User Credentials Search Result Objects</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>View all logins associated with the current user. In the Lead Advantage system, a user can maintain multiple credentials by login context. The body payload of this API request uses the Lead Advantage API Standard <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054403689/Search+Criteria+Object\">Search Criteria Object</a>, and can be customized to return different results and fields as needed.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentUserID}}","userCredentials","search",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0c32497-d3ec-47cc-b547-663d3bcb37e1"},{"name":"Credentials - Change User's Password","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"c2da2a79-1a3f-4092-a570-4548611286d5","request":{"method":"POST","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"user_credentials_id\": \"{{AgentUserCredentialsID}}\",\n    \"user_id\": \"{{AgentUserID}}\",\n    \"login\": \"{{AgentUsername}}\",\n    \"password\": \"{{AgentPassword}}\",\n    \"context\": \"{{APIPartnerLoginContext}}\"\n}"},"url":"https://{{BaseAPI}}/api/user/{{AgentUserID}}/userCredentials/{{AgentUserCredentialsID}}","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for User profile whose credentials you want to update</td>\n</tr>\n<tr>\n<td>user_credentials_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>User Credentials record to update</td>\n</tr>\n<tr>\n<td>body</td>\n<td><a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912315/User+Credentials+Object\">User Credentials Object</a></td>\n<td>HTTP Body</td>\n<td>User Credential fields to update</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912315/User+Credentials+Object\">User Credentials Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Modify the username/password for a user. All usernames must be unique within the context of a given <code>context</code> namespace. Currently, only the namespace of <code>LAPro</code> is supported.</p>\n<p><strong>Note: the</strong> <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3053912315/User+Credentials+Object\">User Credentials Object</a> <strong>will never echo back the password used in the login record.</strong></p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentUserID}}","userCredentials","{{AgentUserCredentialsID}}"],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2da2a79-1a3f-4092-a570-4548611286d5"},{"name":"Delete an Existing User","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"1754187e-63ce-47f3-8c40-9510e6db51ca","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/user/{{AgentOtherUserID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Identifier for the User profile you want to delete in Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Delete an existing user profile from the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentOtherUserID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1754187e-63ce-47f3-8c40-9510e6db51ca"},{"name":"Remove an Address","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"acd0e4f0-d74d-4017-a045-656c73a01d34","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/user/{{AgentOtherUserID}}/address/{{AgentOtherUserAddressID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for User profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>address_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for address record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing address from a user profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentOtherUserID}}","address","{{AgentOtherUserAddressID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"acd0e4f0-d74d-4017-a045-656c73a01d34"},{"name":"Remove a Phone","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"48d90945-1c3b-4522-b93d-0f4d5e22f56c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/user/{{AgentOtherUserID}}/phone/{{AgentOtherUserPhoneID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for User profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>phone_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for phone record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing phone from a user profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentOtherUserID}}","phone","{{AgentOtherUserPhoneID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"48d90945-1c3b-4522-b93d-0f4d5e22f56c"},{"name":"Remove an Email Address","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"55334e83-5b5a-4163-8830-4b9bb9b31de7","request":{"method":"GET","header":[{"key":"Authorization","value":"{{AccessToken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{BaseAPI}}/api/user/{{AgentOtherUserID}}/email/{{AgentOtherUserEmailID}}/delete/","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Argument</th>\n<th>Data Type</th>\n<th>Argument Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>user_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for User profile you want to perform an action on</td>\n</tr>\n<tr>\n<td>email_id</td>\n<td>integer</td>\n<td>Path</td>\n<td>Indentifier for email address record you want to delete from Lead Advantage</td>\n</tr>\n<tr>\n<td>Returns: <a href=\"https://leadadvantage.atlassian.net/wiki/spaces/LEADAPI/pages/3054665916/Delete+Confirmation+Object\">Delete Confirmation Object</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Remove an existing email address from a user profile in the Lead Advantage system.</p>\n","urlObject":{"protocol":"https","path":["api","user","{{AgentOtherUserID}}","email","{{AgentOtherUserEmailID}}","delete",""],"host":["{{BaseAPI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55334e83-5b5a-4163-8830-4b9bb9b31de7"}],"id":"7b4e63ad-04d3-4339-841d-ff00d55ed8ed","description":"<p>Represents individual agents. All actions in the API are performed on behalf of a user record.</p>\n","_postman_id":"7b4e63ad-04d3-4339-841d-ff00d55ed8ed"}],"variable":[{"id":"16ed9f32-8ce9-43a1-a23e-b7649c9695dc","key":"RefreshToken","value":"2a109tU8616JYD4xqETtZEHJOcBWtdBHIxPiKWYvnuUHprZuQa"}]}