Welcome to Excel™ Public API documentation. Here you can find a list of the most common public APIs we make available to our partners. If you have questions kindly contact us at support@excelimpact.com.
\nCheers!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10167691","collectionId":"b242885e-0123-41c7-b539-cde1ff935260","publishedId":"2sA3QmFbPZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-22T13:51:28.000Z"},"item":[{"name":"Site Prefiller","item":[{"name":"Add Customer","id":"f9fcaad5-1442-4c76-bdf8-841f956cad35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_data\": {\r\n \"address\": \"120 Jenkins Rd\",\r\n \"address_2\": \"Apt 12\",\r\n \"children\": [\r\n {\r\n \"birth_date\": \"2011-05-17\",\r\n \"gender\": \"M\",\r\n \"height\": 71,\r\n \"name\": \"James Silverman Jr\",\r\n \"tobacco\": 0,\r\n \"weight\": 145\r\n }\r\n ],\r\n \"contact\": \"Pamela L. Silverman\",\r\n \"county\": \"Los Angeles County\",\r\n \"coverage_type\": \"Individual Family\",\r\n \"credit_rating\": \"average\",\r\n \"current_company\": \"CIGNA\",\r\n \"currently_insured\": 1,\r\n \"denied_coverage\": 0,\r\n \"email\": \"testy@tester.com\",\r\n \"hospitalized\": 1,\r\n \"household_income\": 75000,\r\n \"household_size\": 4,\r\n \"leadid_id\": \"A12E4C9E-FBD5-6778-AC1F-FEFB99DF616A\",\r\n \"lost_coverage\": 1,\r\n \"major_condition_aids_hiv\": 1,\r\n \"major_condition_alcohol_drug_abuse\": 1,\r\n \"major_condition_alzheimers_dementia\": 1,\r\n \"major_condition_asthma\": 1,\r\n \"major_condition_cancer\": 1,\r\n \"major_condition_chronic_pain\": 1,\r\n \"major_condition_clinical_depression\": 1,\r\n \"major_condition_diabetes\": 1,\r\n \"major_condition_emphysema\": 0,\r\n \"major_condition_epilepsy\": 0,\r\n \"major_condition_heart_attack\": 0,\r\n \"major_condition_heart_disease\": 0,\r\n \"major_condition_hepatitis_liver\": 0,\r\n \"major_condition_high_blood_pressure\": 0,\r\n \"major_condition_high_cholesterol\": 0,\r\n \"major_condition_kidney_disease\": 0,\r\n \"major_condition_mental_illness\": 0,\r\n \"major_condition_multiple_sclerosis\": 0,\r\n \"major_condition_other\": 0,\r\n \"major_condition_pulmonary_disease\": 0,\r\n \"major_condition_respiratory_disorder\": 0,\r\n \"major_condition_stroke\": 0,\r\n \"major_condition_ulcers\": 0,\r\n \"major_condition_vascular_disease\": 0,\r\n \"mediaalpha_certificate_id\": \"AATBbWeXM0aZH8iJIwUKhS_b\",\r\n \"phone\": \"(360) 217-9499\",\r\n \"pregnant\": 0,\r\n \"prescription_medications\": \"\",\r\n \"primary\": {\r\n \"birth_date\": \"1984-05-17\",\r\n \"gender\": \"F\",\r\n \"height\": 64,\r\n \"name\": \"Pamela L. Silverman\",\r\n \"tobacco\": 1,\r\n \"weight\": 150\r\n },\r\n \"qualifying_life_event\": \"other\",\r\n \"qualifying_life_event_date\": \"2024-01-01\",\r\n \"score\": 8,\r\n \"self_employed\": 1,\r\n \"spouse\": {\r\n \"birth_date\": \"1950-05-17\",\r\n \"gender\": \"M\",\r\n \"height\": 73,\r\n \"name\": \"James R. Silverman\",\r\n \"tobacco\": 1,\r\n \"weight\": 192\r\n },\r\n \"tcpa\": {\r\n \"call_consent\": 1,\r\n \"email_consent\": 1,\r\n \"sms_consent\": 1,\r\n \"text\": \"By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize QuoteLab and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.\",\r\n \"url\": \"http://www.somdomain.com/privacy-policy.html\"\r\n },\r\n \"treated\": 0,\r\n \"trusted_form_certificate_id\": \"433cb911f1698abec3a8c3514fad789c2541e823\",\r\n \"zip\": \"90210\"\r\n },\r\n \"vertical_name\": \"Health\",\r\n \"campaign_url\": \"https://www.affordablehealthplans.org/landing-page?subid=ABC&campaign=123&...\",\r\n \"publisher_name\": \"Some Publisher\",\r\n \"channel_name\": \"Some Channel\",\r\n \"data_source\": \"Partner Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://prefill.excelimpact.com/prod/","description":"This endpoint allows you to add a customer's information to Excel's Prefiller for it to be used to pre-populate the users's data on Excel Impact's sites.
\nThis request requires an API key, as noted in the Authorization section.
\nThis endpoint expects JSON data using MediaAlpha's Lead Schema, following MediaAlpha's Lead Schemas for each distinct vertical. Please note that you may have a different internal schema than the outlined here, however, it is required that you map to MediaAlpha's schema when integrating with this endpoint. See the different schemas per vertical above.
\nNote: All fields are required!
\nuser_data: A JSON object containing lead data as per MediaAlpha's lead schema for that vertical.
\nvertical_name: The vertical name. Allowed values are Health|Medicare|Life|Auto|Home.
\ncampaign_url: The URL defined at the campaign, ad_group, or ad in MediaAlpha. Do not modify this URL, except by transforming the macros into the final values.
\npublisher_name: The name of the publisher, for debugging purposes should there be increased error rates by Publisher.
\nchannel_name: The name of the channel, for debugging purposes should there be increased error rates by Channel.
\ndata_source: Your Advertising Source's preferred name. This is used for debugging purposes, so we know where the data is coming from and who to talk to to resolve issues.
\nThe system adjusts the url field according to whether it is ready to prefill the customer's information or not. Currently this API can be tested on affordablehealthplans.org (Health), medigap.com/quotes/ (Medicare), burialinsurance.com (Life), and agilerates.com (Auto). Upon receiving enough data, the system should replace any landing page provided in the campaign_url field with the url /form-mediaalpha-prefill, with the p_id and p_key values appended to it. The p_id and p_key values you will receive as part of this API don't need further modifications. The system will take care of appending the values to the URL as necessary.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":true,"source":{"_postman_id":"8f4c9749-34ce-4540-8fc9-711be6708577","id":"8f4c9749-34ce-4540-8fc9-711be6708577","name":"Site Prefiller","type":"folder"}},"urlObject":{"protocol":"https","path":["prod",""],"host":["prefill","excelimpact","com"],"query":[],"variable":[]}},"response":[{"id":"f11f8420-67fb-45b3-849a-195af25a3caf","name":"Add Customer - Success - Health","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_data\": {\r\n \"address\": \"120 Jenkins Rd\",\r\n \"address_2\": \"Apt 12\",\r\n \"children\": [\r\n {\r\n \"birth_date\": \"2011-05-17\",\r\n \"gender\": \"M\",\r\n \"height\": 71,\r\n \"name\": \"James Silverman Jr\",\r\n \"tobacco\": 0,\r\n \"weight\": 145\r\n }\r\n ],\r\n \"contact\": \"Pamela L. Silverman\",\r\n \"county\": \"Los Angeles County\",\r\n \"coverage_type\": \"Individual Family\",\r\n \"credit_rating\": \"average\",\r\n \"current_company\": \"CIGNA\",\r\n \"currently_insured\": 1,\r\n \"denied_coverage\": 0,\r\n \"email\": \"testy@tester.com\",\r\n \"hospitalized\": 1,\r\n \"household_income\": 75000,\r\n \"household_size\": 4,\r\n \"leadid_id\": \"A12E4C9E-FBD5-6778-AC1F-FEFB99DF616A\",\r\n \"lost_coverage\": 1,\r\n \"major_condition_aids_hiv\": 1,\r\n \"major_condition_alcohol_drug_abuse\": 1,\r\n \"major_condition_alzheimers_dementia\": 1,\r\n \"major_condition_asthma\": 1,\r\n \"major_condition_cancer\": 1,\r\n \"major_condition_chronic_pain\": 1,\r\n \"major_condition_clinical_depression\": 1,\r\n \"major_condition_diabetes\": 1,\r\n \"major_condition_emphysema\": 0,\r\n \"major_condition_epilepsy\": 0,\r\n \"major_condition_heart_attack\": 0,\r\n \"major_condition_heart_disease\": 0,\r\n \"major_condition_hepatitis_liver\": 0,\r\n \"major_condition_high_blood_pressure\": 0,\r\n \"major_condition_high_cholesterol\": 0,\r\n \"major_condition_kidney_disease\": 0,\r\n \"major_condition_mental_illness\": 0,\r\n \"major_condition_multiple_sclerosis\": 0,\r\n \"major_condition_other\": 0,\r\n \"major_condition_pulmonary_disease\": 0,\r\n \"major_condition_respiratory_disorder\": 0,\r\n \"major_condition_stroke\": 0,\r\n \"major_condition_ulcers\": 0,\r\n \"major_condition_vascular_disease\": 0,\r\n \"mediaalpha_certificate_id\": \"AATBbWeXM0aZH8iJIwUKhS_b\",\r\n \"phone\": \"(360) 217-9499\",\r\n \"pregnant\": 0,\r\n \"prescription_medications\": \"\",\r\n \"primary\": {\r\n \"birth_date\": \"1984-05-17\",\r\n \"gender\": \"F\",\r\n \"height\": 64,\r\n \"name\": \"Pamela L. Silverman\",\r\n \"tobacco\": 1,\r\n \"weight\": 150\r\n },\r\n \"qualifying_life_event\": \"other\",\r\n \"qualifying_life_event_date\": \"2024-01-01\",\r\n \"score\": 8,\r\n \"self_employed\": 1,\r\n \"spouse\": {\r\n \"birth_date\": \"1979-05-17\",\r\n \"gender\": \"M\",\r\n \"height\": 73,\r\n \"name\": \"James R. Silverman\",\r\n \"tobacco\": 1,\r\n \"weight\": 192\r\n },\r\n \"tcpa\": {\r\n \"call_consent\": 1,\r\n \"email_consent\": 1,\r\n \"sms_consent\": 1,\r\n \"text\": \"By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize QuoteLab and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.\",\r\n \"url\": \"http://www.somedomain.com/privacy-policy.html\"\r\n },\r\n \"treated\": 0,\r\n \"trusted_form_certificate_id\": \"433cb911f1698abec3a8c3514fad789c2541e823\",\r\n \"zip\": \"90210\"\r\n },\r\n \"vertical_name\": \"Health\",\r\n \"campaign_url\": \"https://www.affordablehealthplans.org/landing-page?subid=ABC&campaign=123&...\",\r\n \"publisher_name\": \"Some Publisher\",\r\n \"channel_name\": \"Some Channel\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://prefill.excelimpact.com/prod/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"292"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 May 2024 21:39:04 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"p_id\": \"4ae91bd6-aabd-4fde-b0ba-000000000\",\n \"p_key\": \"17584303-d199-4d26-9b91-00000000\",\n \"url\": \"https://www.affordablehealthplans.org/form-mediaalpha-prefill?subid=ABC&campaign=123&...=&p_id=4ae91bd6-aabd-4fde-b0ba-000000000&p_key=17584303-d199-4d26-9b91-0000000000\"\n}"},{"id":"b3f8e674-6b30-4ba7-ae71-54de94367534","name":"Add Customer - Success - Medicare","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_data\": {\r\n \"address\": \"120 Jenkins Rd\",\r\n \"address_2\": \"Apt 12\",\r\n \"birth_date\": \"1959-06-05\",\r\n \"city\": \"Los Angeles\",\r\n \"contact\": \"Pamela L. Silverman\",\r\n \"county\": \"Los Angeles County\",\r\n \"coverage_type\": \"Medicare Advantage\",\r\n \"credit_rating\": \"average\",\r\n \"csnp\": 1,\r\n \"currently_insured\": 1,\r\n \"dsnp\": 1,\r\n \"email\": \"testy@tester.com\",\r\n \"gender\": \"F\",\r\n \"household_income\": 75000,\r\n \"leadid_id\": \"A12E4C9E-FBD5-6778-AC1F-FEFB99DF616A\",\r\n \"major_condition_aids_hiv\": 1,\r\n \"major_condition_alcohol_drug_abuse\": 1,\r\n \"major_condition_alzheimers_dementia\": 1,\r\n \"major_condition_asthma\": 1,\r\n \"major_condition_cancer\": 1,\r\n \"major_condition_chronic_pain\": 1,\r\n \"major_condition_clinical_depression\": 1,\r\n \"major_condition_diabetes\": 1,\r\n \"major_condition_emphysema\": 0,\r\n \"major_condition_epilepsy\": 0,\r\n \"major_condition_heart_attack\": 0,\r\n \"major_condition_heart_disease\": 0,\r\n \"major_condition_hepatitis_liver\": 0,\r\n \"major_condition_high_blood_pressure\": 0,\r\n \"major_condition_high_cholesterol\": 0,\r\n \"major_condition_kidney_disease\": 0,\r\n \"major_condition_mental_illness\": 0,\r\n \"major_condition_multiple_sclerosis\": 0,\r\n \"major_condition_other\": 0,\r\n \"major_condition_pulmonary_disease\": 0,\r\n \"major_condition_respiratory_disorder\": 0,\r\n \"major_condition_stroke\": 0,\r\n \"major_condition_ulcers\": 0,\r\n \"major_condition_vascular_disease\": 0,\r\n \"mediaalpha_certificate_id\": \"AATBbWeXM0aZH8iJIwUKhS_b\",\r\n \"phone\": \"(360) 217-9499\",\r\n \"qualifying_life_event\": \"other\",\r\n \"score\": 8,\r\n \"tcpa\": {\r\n \"call_consent\": 1,\r\n \"email_consent\": 1,\r\n \"sms_consent\": 1,\r\n \"text\": \"By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize QuoteLab and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text message or emails, or direct you to a licensed sales agent who can answer your questions and provide information about Medicare Advantage, Medicare Supplement and Prescription Drug plans or Life Insurance plans by phone or email. Agents are not connected with or endorsed by the U.S. government or the federal Medicare program. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.\",\r\n \"url\": \"http://www.somedomain.com/privacy-policy.html\"\r\n },\r\n \"tobacco\": 0,\r\n \"trusted_form_certificate_id\": \"433cb911f1698abec3a8c3514fad789c2541e823\",\r\n \"zip\": \"90210\"\r\n },\r\n \"vertical_name\": \"Medicare\",\r\n \"campaign_url\": \"https://www.medigap.com/quotes/landing-page?subid=ABC&campaign=123&...\",\r\n \"publisher_name\": \"Some Publisher\",\r\n \"channel_name\": \"Some Channel\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://prefill.excelimpact.com/prod/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"292"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 May 2024 21:39:04 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"p_id\": \"2914f3fd-db89-4ef5-a55e-000000000\",\n \"p_key\": \"d6b79d30-df81-47b6-a7db-0000000000\",\n \"url\": \"https://www.medigap.com/quotes/form-mediaalpha-prefill?subid=ABC&campaign=123&...=&p_id=2914f3fd-db89-4ef5-a55e-0000000000f&p_key=d6b79d30-df81-47b6-a7db-000000000\"\n}"},{"id":"3922dd45-d3d6-449b-be06-96f35bcb3b17","name":"Add Customer - Success - Auto","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_data\": {\r\n \"address\": \"120 Jenkins Rd\",\r\n \"address_2\": \"Apt 12\",\r\n \"bi_per_incident\": \"100000\",\r\n \"bi_per_person\": \"50000\",\r\n \"contact\": \"Pamela L. Silverman\",\r\n \"continuous_coverage\": 121,\r\n \"coverage_type\": \"Standard Protection\",\r\n \"current_company\": \"Progressive\",\r\n \"current_customer\": 48,\r\n \"current_policy_expires\": 2,\r\n \"current_policy_premium\": 234,\r\n \"currently_insured\": 1,\r\n \"drivers\": [\r\n {\r\n \"bankruptcy\": 0,\r\n \"birth_date\": \"1974-07-17\",\r\n \"credit_rating\": \"average\",\r\n \"driver\": \"Pamela L. Silverman\",\r\n \"education\": \"associate\",\r\n \"first_licensed\": 16,\r\n \"gender\": \"F\",\r\n \"license_state\": \"GA\",\r\n \"license_status\": \"active\",\r\n \"marital_status\": \"married\",\r\n \"occupation\": \"administrative clerical\",\r\n \"primary_vehicle\": 0,\r\n \"relationship\": \"self\",\r\n \"sr_22\": 0,\r\n \"suspended_reason\": \"no insurance\"\r\n },\r\n {\r\n \"bankruptcy\": 0,\r\n \"birth_date\": \"1979-09-12\",\r\n \"credit_rating\": \"good\",\r\n \"driver\": \"James S. Silverman\",\r\n \"education\": \"associate\",\r\n \"first_licensed\": 17,\r\n \"gender\": \"M\",\r\n \"license_state\": \"GA\",\r\n \"license_status\": \"active\",\r\n \"marital_status\": \"married\",\r\n \"occupation\": \"other technical\",\r\n \"primary_vehicle\": 1,\r\n \"relationship\": \"spouse\",\r\n \"sr_22\": 0\r\n },\r\n {\r\n \"bankruptcy\": 1,\r\n \"birth_date\": \"2006-04-23\",\r\n \"credit_rating\": \"average\",\r\n \"driver\": \"Arthur Silverman\",\r\n \"education\": \"high school\",\r\n \"first_licensed\": 16,\r\n \"gender\": \"M\",\r\n \"good_student\": 1,\r\n \"license_state\": \"GA\",\r\n \"license_status\": \"active\",\r\n \"marital_status\": \"single\",\r\n \"occupation\": \"student\",\r\n \"primary_vehicle\": 1,\r\n \"relationship\": \"child\",\r\n \"sr_22\": 0\r\n }\r\n ],\r\n \"email\": \"testy@tester.com\",\r\n \"home_garage\": 1,\r\n \"home_length\": 121,\r\n \"home_ownership\": 1,\r\n \"incidents\": [\r\n {\r\n \"description\": \"More than 10 MPH over\",\r\n \"driver\": 0,\r\n \"incident_date\": \"06/2022\",\r\n \"type\": \"ticket\"\r\n },\r\n {\r\n \"amount_paid\": \"200\",\r\n \"claim_at_fault\": 1,\r\n \"description\": \"Act of Nature\",\r\n \"driver\": 1,\r\n \"incident_date\": \"03/2023\",\r\n \"type\": \"claim\"\r\n },\r\n {\r\n \"accident_at_fault\": 1,\r\n \"amount_paid\": \"450\",\r\n \"description\": \"Hit while stopped\",\r\n \"driver\": 2,\r\n \"incident_date\": \"06/2022\",\r\n \"liability_medical_paid\": 0,\r\n \"type\": \"accident\",\r\n \"what_damaged\": \"property\"\r\n },\r\n {\r\n \"amount_paid\": \"550\",\r\n \"claim_at_fault\": 0,\r\n \"description\": \"Hail damage\",\r\n \"driver\": 1,\r\n \"incident_date\": \"06/2023\",\r\n \"type\": \"claim\"\r\n },\r\n {\r\n \"driver\": 1,\r\n \"incident_date\": \"04/2023\",\r\n \"type\": \"suspension\"\r\n },\r\n {\r\n \"driver\": 1,\r\n \"dui_state\": \"NM\",\r\n \"incident_date\": \"03/2023\",\r\n \"type\": \"dui\"\r\n }\r\n ],\r\n \"interested_in_condo_insurance\": 1,\r\n \"interested_in_home_insurance\": 1,\r\n \"interested_in_life_insurance\": 1,\r\n \"interested_in_renters_insurance\": 1,\r\n \"interested_in_usage_based_policy\": 1,\r\n \"leadid_id\": \"A12E4C9E-FBD5-6778-AC1F-FEFB99DF616A\",\r\n \"mediaalpha_certificate_id\": \"AATBbWeXM0aZH8iJIwUKhS_b\",\r\n \"military_affiliation\": 1,\r\n \"phone\": \"(360) 217-9499\",\r\n \"score\": 8,\r\n \"tcpa\": {\r\n \"call_consent\": 1,\r\n \"email_consent\": 1,\r\n \"sms_consent\": 1,\r\n \"text\": \"By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize QuoteLab and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.\",\r\n \"url\": \"http://www.somedomain.com/privacy-policy.html\"\r\n },\r\n \"trusted_form_certificate_id\": \"433cb911f1698abec3a8c3514fad789c2541e823\",\r\n \"vehicles\": [\r\n {\r\n \"alarm\": 1,\r\n \"annual_mileage\": 25000,\r\n \"auto_warranty\": 1,\r\n \"average_mileage\": 10,\r\n \"collision\": \"500\",\r\n \"commute_days_per_week\": 1,\r\n \"comprehensive\": \"500\",\r\n \"current_mileage\": 40000,\r\n \"make\": \"HONDA\",\r\n \"model\": \"CIVIC SI\",\r\n \"ownership\": \"finance\",\r\n \"primary_driver\": 0,\r\n \"primary_purpose\": \"commute work\",\r\n \"submodel\": \"SEDAN 4 DOOR\",\r\n \"vin\": \"SHHFC1E50HH000000\",\r\n \"year\": 2022\r\n },\r\n {\r\n \"alarm\": 0,\r\n \"annual_mileage\": 17000,\r\n \"auto_warranty\": 1,\r\n \"average_mileage\": 2,\r\n \"collision\": \"500\",\r\n \"commute_days_per_week\": 2,\r\n \"comprehensive\": \"500\",\r\n \"current_mileage\": 40000,\r\n \"make\": \"FORD\",\r\n \"model\": \"ESCAPE S\",\r\n \"ownership\": \"lease\",\r\n \"primary_driver\": 1,\r\n \"primary_purpose\": \"pleasure\",\r\n \"submodel\": \"SPORT UTILITY VEHICLE 4 DOOR\",\r\n \"vin\": \"1FMCU0F70DU000000\",\r\n \"year\": 2018\r\n }\r\n ],\r\n \"zip\": \"90210\"\r\n },\r\n \"vertical_name\": \"Auto\",\r\n \"campaign_url\": \"https://www.agilerates.com/quotes/landing-page?subid=ABC&campaign=123&...\",\r\n \"publisher_name\": \"Some Publisher\",\r\n \"channel_name\": \"Some Channel\",\r\n \"data_source\": \"MediaAlpha\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://prefill.excelimpact.com/prod/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 17 Sep 2024 15:18:15 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"p_id\": \"51d2f5c0-5fb4-4ba1-9fe2-0000000000\",\n \"p_key\": \"9cf6efbb-c63a-4054-b05d-0000000000\",\n \"url\": \"https://www.agilerates.com/quotes/form-mediaalpha-prefill?subid=ABC&campaign=123&...=&p_id=51d2f5c0-5fb4-4ba1-9fe2-0000000000&p_key=9cf6efbb-c63a-4054-b05d-0000000000\"\n}"},{"id":"fc1b5a17-0a76-4ce0-b410-bee887441cd0","name":"Add Customer - Incomplete Data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n \"vertical_name\": \"Health\",\r\n \"campaign_url\": \"https://www.affordablehealthplans.org/landing-page?subid=ABC&campaign=123&...\",\r\n \"publisher_name\": \"Some Publisher\",\r\n \"channel_name\": \"Some Channel\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://prefill.excelimpact.com/prod/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"96"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 20 May 2024 21:58:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"url\": \"https://www.affordablehealthplans.org/landing-page?subid=ABC&campaign=123&...\"\n}"}],"_postman_id":"f9fcaad5-1442-4c76-bdf8-841f956cad35"}],"id":"8f4c9749-34ce-4540-8fc9-711be6708577","description":"This API collection was built as a collaboration between Advertising Networks and Excel Impact, in order to pass data securely between the platforms. This collection holds the documentation for that allows Excel to prefill their sites from clicks purchased on those advertising networks.
\nThe diagram below should help explain how to use these APIs for the desired behavior.
\nThe current implementation supports out of the box the following verticals
\nHealth
\nMedicare
\nLife
\nAuto
\nThe following vertical will be integrated shortly:
\nShould the endpoint return anything other than a 200, the expected error handling on the advertiser network's side is to simply redirect the consumer to the already defined URL in the ad, ad_group or campaign. The system should return this URL by default in the \"url\" field, but this is not guaranteed in the case of fatal failures on the code or infrastructure sides.
\nTesting the system should be done as follows:
\nSend user data to the API, setting the campaign_url to: https://medigap.com/quotes/my-landing-page
\nThe system should return a URL that looks like this: https://medigap.com/quotes/form-mediaalpha-prefill?p_id=2c19dc4a-d92a-42b1-bd85-13a05c4934b9&p_key=406376ca-29af-48e6-8881-f4f5eb0bb612
\nNavigate to that URL
\nThe form should be prefilled with as much information as was provided in step 1
\nIf full data was provided, the user will briefly see Step 1, and then be taken to the last step of the form as soon as all data is loaded
\nIf partial data was provided, the user will be taken to the step where the partial data was missing, but everything else will be prefilled for the user, regardless of whether that data is requested later in the form
\nIf no data or not enough data is provided, the system will return the same campaign_url that was given to it, essentially taking the consumer to the landing page
\n\"user_data\" should be passed to the system following the schemas below:
\nHealth: https://insurance-exchange.mediaalpha.com/help/health-insurance-lead-representation.html
\nMedicare: https://insurance-exchange.mediaalpha.com/help/medicare-insurance-lead-representation.html
Life: https://insurance-exchange.mediaalpha.com/help/life-insurance-lead-representation.html
Auto: https://insurance-exchange.mediaalpha.com/help/auto-insurance-lead-representation.html
\nHome: https://insurance-exchange.mediaalpha.com/help/home-insurance-lead-representation.html
\nIf you have discrepancies with this schema or cannot find how to map a value properly, please contact support@ for clarification.
\nOur domain name is excelimpact.com.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a47c1a57-96f6-4976-bc19-c8b07c9042c8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b0ad46a3-7417-4bf6-9a7f-eb74b8171660","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"8f4c9749-34ce-4540-8fc9-711be6708577"},{"name":"DNC Integration","item":[{"name":"Add a DNC record","id":"5de21245-7d71-4a27-a06a-880c34b374a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"","type":"text","description":"Request from Excel Impact’s Technical Team
\n"}],"body":{"mode":"raw","raw":"{\n \"email_address\": \"the_email@ddress.com\",\n \"phone_number\": \"3055555555\",\n \"source\": \"YourSourceName\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dnc.excelimpact.com/do-not-call","description":"The following outlines how to pass DNC information back to Excel Impact. If you also receive DNC information from Excel Impact, you might receive a ping with this same information through whatever method you are integrated with, so a circular request is possible and should be considered. If that’s the case, please discuss this with Excel Impact’s technical team.
\nEmail/Phone – Only one of these values is required. If you don’t have the value, don’t pass it. If you have both values, please pass them.
\nSource – Your source as a string. You can coordinate with the Excel Impact tech team if you need guidance, but so long as it is consistent and clear this is fine.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":true,"source":{"_postman_id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","name":"DNC Integration","type":"folder"}},"urlObject":{"protocol":"https","path":["do-not-call"],"host":["dnc","excelimpact","com"],"query":[],"variable":[]}},"response":[{"id":"cdaeea6c-7fbe-407e-af55-17cff12a854e","name":"Add a DNC record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"My_Awesome_Key","type":"text","description":"Request from Excel Impact’s Technical Team"}],"body":{"mode":"raw","raw":"{\n \"email_address\": \"the_email@ddress.com\",\n \"phone_number\": \"3055555555\",\n \"source\": \"YourSourceName\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dnc.excelimpact.com/do-not-call"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request submitted successfully\"\n}"}],"_postman_id":"5de21245-7d71-4a27-a06a-880c34b374a7"},{"name":"Check For Permissions (One lead at the time)","id":"37beea5d-2635-478a-8cf4-cf8fd4ab09dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"","type":"text","description":"Request From Excel Impact’s technical team
\n"}],"body":{"mode":"raw","raw":"{\n \"Lead\": {\n \"email_address\" : \"the_email@ddress.com\",\n \"phone_number\" : \"3055555555\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://dnc.excelimpact.com/check-permissions","description":"The following endpoint is useful for ensuring whether Excel Impact has TCPA consent to SMS/Call a customer. This is to be used only if you have express written consent (through a legal contract) to act on behalf of Excel Impact.
\nIf you only have the phone number of the consumer, only pass the phone number, and eliminate the email_address parameter completely (both key and value).\nThe Booleans are represented as true/false. A true means we have the consent to perform the action described.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":true,"source":{"_postman_id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","name":"DNC Integration","type":"folder"}},"urlObject":{"protocol":"https","path":["check-permissions"],"host":["dnc","excelimpact","com"],"query":[],"variable":[]}},"response":[{"id":"9fd858b2-3c5d-4ba7-9bbf-735a25b29d34","name":"Check For Permissions (One lead at the time)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"My_Awesome_Key","type":"text","description":"Request From Excel Impact’s technical team"}],"body":{"mode":"raw","raw":"{\n \"Lead\": {\n \"email_address\" : \"the_email@ddress.com\",\n \"phone_number\" : \"3055555555\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://dnc.excelimpact.com/check-permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"sms_consent\": true,\n \"call_consent\": false,\n \"mail_consent\": true,\n \"email_consent\": false\n}\n"}],"_postman_id":"37beea5d-2635-478a-8cf4-cf8fd4ab09dc"},{"name":"Check For Permissions (Batch)","id":"4b385ff1-fa71-487a-a435-f6bb1d2a0d4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"","type":"text","description":"Request From Excel Impact’s technical team
\n"}],"body":{"mode":"raw","raw":"{\n \"email_addresses\": [\n \"the_email@ddress.com\",\n \"another_email@ddress.com\"\n ],\n \"phone_numbers\": [\n \"3055555555\",\n \"3055555556\"\n ]\n}"},"url":"https://dnc.excelimpact.com/scrub","description":"The following endpoint is useful for ensuring whether Excel Impact has TCPA consent to SMS/Call several customers at once. This is to be used only if you have express written consent (through a legal contract) to act on behalf of Excel Impact.
\nThe response will provide you only with the numbers (or email addresses) of the people we have consent to SMS/Call/Email. If you pass 10 numbers and none return, is because we don’t have consent to SMS any of them.\nIf you only have the phone number of the consumer, only pass the phone number, and eliminate the email_addresses parameter completely (both key and values). If you don’t have any permissions, the response from the API will be an empty object “{}”. For example, on the request above, if we had permission to call the consumers above, but not to email them, the “email_addresses” key would not have been returned as part of the response, but both phone numbers would have been returned under “phone_numbers”.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":true,"source":{"_postman_id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","name":"DNC Integration","type":"folder"}},"urlObject":{"protocol":"https","path":["scrub"],"host":["dnc","excelimpact","com"],"query":[],"variable":[]}},"response":[{"id":"e06252bf-c512-45a6-ba33-cb9b8ce5704d","name":"Check For Permissions (Batch)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"My_Awesome_Key","type":"text","description":"Request From Excel Impact’s technical team"}],"body":{"mode":"raw","raw":"{\n \"email_addresses\": [\n \"the_email@ddress.com\",\n \"another_email@ddress.com\"\n ],\n \"phone_numbers\": [\n \"3055555555\",\n \"3055555556\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dnc.excelimpact.com/scrub"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"email_addresses\": [\n \"the_email@ddress.com\"\n ],\n \"phone_numbers\": [\n \"3055555555\"\n ]\n}"}],"_postman_id":"4b385ff1-fa71-487a-a435-f6bb1d2a0d4a"}],"id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Contact Excel Impact For Value"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a69e2651-a71d-4f64-bcb2-e82189c89ab7","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"fd8be67c-2b79-4927-865e-39ba737dea8a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"3e2cf9a4-a550-4abc-b989-988fabad5b1d","description":""},{"name":"Dispositions","item":[{"name":"Submit Disposition","id":"0d7aaa2d-1572-419f-8072-fe93b6de6576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"","description":"Request from Excel Impact’s Technical Team
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_name\": \"Some list name\",\r\n \"phone_number\": \"3055555566\",\r\n \"email_address\": \"testy@tester.com\",\r\n \"created_date\": \"2025-12-01\",\r\n \"transaction_type\": \"Lead\",\r\n \"carrier_name\": \"Some Buyer\",\r\n \"vertical\": \"Health\",\r\n \"campaign_name\": \"Some Buyer - Leads - Premium\",\r\n \"campaign_type\": \"standard\",\r\n \"mediaalpha_token\": \"ABC123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://enhance.excelimpact.com/dispositions","description":"This endpoint allows you to submit the disposition of a lead to Excel’s Dispositions API. It is typically used to record the outcome of a call, lead or click event, including routing and campaign context to allow Excel to optimize your campaigns to drive better results.
\nMethod: POST
URL: https://enhance.excelimpact.com/dispositions
Body Type: raw JSON
All of the following fields are allowed in the JSON payload, but most are optional:
\n{\n \"list_name\": \"Some list name\",\n \"phone_number\": \"3055555566\",\n \"email_address\": \"testy@tester.com\",\n \"created_date\": \"2025-12-01\",\n \"transaction_type\": \"Lead\",\n \"carrier_name\": \"Some Buyer\",\n \"vertical\": \"Health\",\n \"campaign_name\": \"Some Buyer - Leads - Premium\",\n \"campaign_type\": \"No IVR Treatment\",\n \"mediaalpha_token\": \"ABC123\"\n}\n\nlist_name (string, optional) – Logical name of the list or source the lead/disposition belongs to. You may use campaign_name if it makes more sense to you.
phone_number (string, recommended) – Contact phone number for the lead. Click dispositions may not have the phone number attached.
email_address (string, recommended) – Contact email address for the lead. Call dispositions may not have the email address of the lead.
created_date (string, required) – Date the lead was acquired, formatted as YYYY-MM-DD. This allows us to tie the record better on our system as you may acquire the same lead more than once throughout the years.
transaction_type (string, recommended) – The type of transaction being submitted (for example, Lead, Call, Click).
carrier_name (string, required) – Name of the buyer/carrier associated with this disposition. This would be your name in our system.
vertical (string, required) – Business vertical for the lead (for example, Health, Medicare, Life, Auto, Home).
campaign_name (string, recommended) – Human-readable campaign name used for reporting and tracking.
campaign_type (string, optional) – Campaign classification or treatment type (for example, No IVR Treatment).
mediaalpha_token (string, optional) – Attribution or tracking token used to associate the event with the original source if you used MediaAlpha to purchase the traffic from us. This is mostly relevant when purchasing Clicks since the email or phone number may not be known at that point.
On a valid request, the Dispositions API will record the disposition event with the provided metadata and return a response indicating success or failure (see API documentation or examples for exact schema and status codes).
\nIf required fields are missing or malformed, the API is expected to return an error response describing the validation issue.
\nKeep values for campaign_name, and campaign_type aligned with your internal naming conventions.
Keep vertical and transaction_type within the allowed parameters. Those are case sensitive.
\nThe example JSON body in this request is intended as a template—update field values to match your production or sandbox data before sending.
\n