
Ping & Post Instructions
for Health Insurance / Medicare
Let's Make A Lead API
Please use the following instructions to use our Ping/Post or Direct Post system for Health Insurance / Medicare Vertical.
In order to get identified, you will need to send the following parameters:
In order to get identified, you will need to send the following parameters:
Ping Required |
Post Required |
field | Contents | Example of value |
---|---|---|---|---|
YES | YES | partnerid | Will be provided | XYZ |
YES | YES | key | Will be provided | 771f5924706521c73464341fc48afb05 |
YES | YES | numcategory |
1004 - Health Insurance / Medicare |
1004 |
YES | YES | subid | Your sub Source | 123 |
OPTION | OPTION | resptype | 'XML' to receive an XML response. 'JSON' to receive an JSON response. if empty, the response format will be by default. |
XML |
NO | OPTION | price_tag | 1 to receive the Price inside the Post response. if empty, the response format will be by default. (See response example) |
1 |
NO | YES | token | Value you received in case of positive Ping. Must be sent on the Post. |
e69412030cc93b47cf5be6f7e3ee998c |
Fields Required for Health Insurance / Medicare
Ping Required |
Post Required |
fieldname | Value - Label | Example of value | |
---|---|---|---|---|---|
YES | YES | ip | varchar(50) | 10.0.0.1 | |
YES | YES | requested_coverage_types | integer Set. Allowed values: 1 - IndividualFamily 2 - Medicare 3 - MedicareSupplement 4 - MedicareAdvantage 5 - Medicaid show all |
1 | |
YES | YES | tcpa_optin | integer Set. Allowed values: 0 - No 1 - Yes |
1 | |
YES | YES | zipcode | varchar(5) | 33139 | |
YES | YES | gender | integer Set. Allowed values: 1 - M 2 - F |
1 | |
YES | YES | birth_date | varchar(10) (YYYY-MM-DD) |
1993-12-03 | |
YES | YES | household_income | integer | 10000 | |
YES | YES | expectantmother | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | have_preexisting_medical_conditions complementary datas are requireds if have_preexisting_medical_conditions is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | tobacco | integer Set. Allowed values: 0 - No 1 - Yes |
1 | |
YES | YES | previously_denied | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | currently_insured complementary datas are requireds if currently_insured is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | height | integer (Inches and greater than 10) |
70 | |
YES | YES | weight | integer (Pounds) |
165 | |
YES | YES | bmi | integer | 24 | |
YES | YES | student | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | currently_employed | integer Set. Allowed values: 0 - No 1 - Yes |
1 | |
YES | YES | selfemployed | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | occupation | integer Set. Allowed values: 1 - Advertising/Public Relations 2 - Arts/Entertainment/Publishing 3 - Banking/Mortgage 4 - Clerical 5 - Clergy/Religious show all |
26 | |
YES | YES | dui | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | ongoing_medical_treatment | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | hospitalized | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | prescriptions | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
YES | YES | relative_heart | integer Set. Allowed values: 0 - No 1 - Yes |
1 | |
YES | YES | relative_cancer | integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
NO | YES | state | varchar(2) Set. Allowed values: 1 - AL 2 - AK 4 - AZ 5 - AR 6 - CA show all |
FL | |
NO | YES | firstname | varchar(50) | John | |
NO | YES | lastname | varchar(50) | Doe | |
NO | YES | varchar(50) | johndoe@gmail.com | ||
NO | YES | telephone | varchar(10) | 8772681223 | |
NO | YES | address | varchar(255) | 1210 Ocean Drive | |
NO | YES | city | varchar(50) | Miami | |
NO | OPTION | customid | varchar(50) - Your custom Id | 12345 | |
OPTION | YES | tcpa_text | varchar(5000) | TCPA Consent Text | |
OPTION | NO | trusted_form_available | 1 (Yes) | 1 | |
OPTION | NO | universal_leadid_available | 1 (Yes) | 1 | |
OPTION | OPTION | lead_born_datetime | Y-m-d h:i:s | 2023-01-01 11:50:23 | |
OPTION | OPTION | comments | varchar(500) | Your Comment here | |
OPTION | OPTION | landing_page_url | varchar(255) | https://www.adopt-an-insurer.com/ | |
OPTION | OPTION | shared complementary datas are requireds if shared is sent and ≠ 0 ![]() |
1 (Yes) | 0 | |
OPTION | OPTION | trusted_form_token | varchar(255) | 544fa56524d00e3a0cb321b988fc40d8c42c7160 | |
OPTION | OPTION | universal_leadid | varchar(50) | FFEA9CB6-1A2D-9DA3-0188-96A93D26875C | |
OPTION | OPTION | user_agent | varchar(255) | Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36 | |
OPTION | OPTION | 1to1consent complementary datas are requireds if 1to1consent is sent and ≠ 0 ![]() |
0 (No), 1 (Yes). 0 by default | 0 | |
OPTION | OPTION | optional_coverage | varchar (100) | Accidental Death | |
OPTION | OPTION | when_to_contact | integer Set. Allowed values: 1 - Morning 2 - Afternoon 3 - Evening 4 - Anytime |
3 | |
OPTION | OPTION | plan_type | varchar (50) | PPO | |
OPTION | OPTION | qualifying_life_condition | integer Set. Allowed values: 1 - Married Or Divorced 2 - Had Baby 3 - Family Member Died 4 - Moved To Another State 5 - Lost My Job show all |
3 | |
OPTION | OPTION | residence_status | integer Set. Allowed values: 1 - Own 2 - Rent 3 - Live With Parents 4 - Dormitory 5 - Choice Not Listed |
3 | |
OPTION | OPTION | number_in_household | integer | 3 | |
OPTION | OPTION | treated_by_physcian_in_past_12_months | boolean Set. Allowed values: 0 - No 1 - Yes |
1 | |
OPTION | OPTION | prescription_description | varchar(2550) | Currently using Aerospan for Asthma | |
OPTION | OPTION | spouse complementary datas are requireds if spouse is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_1 complementary datas are requireds if child_1 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_2 complementary datas are requireds if child_2 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_3 complementary datas are requireds if child_3 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_4 complementary datas are requireds if child_4 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_5 complementary datas are requireds if child_5 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 | |
OPTION | OPTION | child_6 complementary datas are requireds if child_6 is sent and ≠ 0 ![]() |
integer Set. Allowed values: 0 - No 1 - Yes |
0 |
PING API
Methods
You can call the PING API using three different methods:cURL POST with URL-encoded data
cURL POST with JSON data
HTTP GET request
Required Fields
When making a PING request, the following fields are mandatory and must be included: partnerid: Your unique partner ID.
key: Your API key for authentication.
numcategory: The category number for the service.
subid: Your unique sub ID.
In addition to the fields mentioned above, all fields marked as "Ping Required" with Yes in the "Fields Required" table above must also be included in the request.
Response
The API will respond in one of the following ways:Accepted: We will return a price and a token that you can reuse in the POST API.
Rejected: The request will be rejected with a detailed reason provided in the response.
You can call the PING API using three different methods:
Required Fields
When making a PING request, the following fields are mandatory and must be included:
In addition to the fields mentioned above, all fields marked as "Ping Required" with Yes in the "Fields Required" table above must also be included in the request.
Response
The API will respond in one of the following ways:
TEST MODE |
---|
Only For test Mode please :
|
#errorCode# | Meaning |
---|---|
1000 | Server under maintenance |
1100 | Request limit exceeded |
2000 | Invalid Partner ID or Blocked source |
3000 | Approval Phase |
4000 | Daily Cap reached |
5000 | No coverage or buyers |
6000 | Minimum bid not met |
Other | Ask Your Representative |
POST API
Required Fields
When making a POST request, the following fields are mandatory and must be included:partnerid: Your unique partner ID.
key: Your API key for authentication.
numcategory: The category number for the service.
subid: Your unique sub ID.
token: the token received on the Ping response.
In addition to the fields mentioned above, all fields marked as "Post Required" with Yes in the "Fields Required" table above must also be included in the request.
Response
The post API will respond in one of the following ways:Accepted:
see examples...
Rejected: if the leads is post rejected, .
When making a POST request, the following fields are mandatory and must be included:
In addition to the fields mentioned above, all fields marked as "Post Required" with Yes in the "Fields Required" table above must also be included in the request.
Response
The post API will respond in one of the following ways: