Ping & Post API

Posting Instructions Fields Required Ping API Post
Health Ins. Home Ins. Legal Auto Ins. Home Services Life ins. Finance / Debt.
Calls
Call Home services Call Auto Ins. Call Health Ins. Call Legal. Call Finance/Debt.

Ping & Post Instructions
for Home Insurance

Let's Make A Lead API
Please use the following instructions to use our Ping/Post or Direct Post system for Home Insurance Vertical.
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 1002 - Home Insurance   
1002
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
YES price The payout for the lead in $.
 0.15
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 Home Insurance
Ping
Required 		Post
Required 		fieldname Value - Label Example of value
YES YES ip varchar(50) 198.50.155.124
YES YES tcpa_optin 1 (Yes) or 2 (No) Set. Allowed values:
1 - Yes
2 - No
1
YES YES tcpa_text varchar(5000) Your TCPA language
YES YES zipcode varchar(5)
registrant’s zip code 		33139
YES YES property_type integer Set. Allowed values:
1 - Single Family
2 - Multi-Family
3 - Condominium
4 - Town House
5 - Mobile Home

show all 		1
YES YES year_built integer 1982
YES YES occupancy integer Set. Allowed values:
1 - Primary Residence
2 - Secondary Residence
3 - Vacation Property
4 - Rental Property
2
YES YES newly_purchased integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES currently_insured
complementary datas are requireds if currently_insured is sent and ≠ 0
display complementary datas
 integer Set. Allowed values:
0 - No
1 - Yes
0
YES YES claim1
complementary datas are requireds if claim1 is sent and ≠ 0
display complementary datas
 integer Set. Allowed values:
0 - no
1 - yes
0
YES YES credit_rating integer Set. Allowed values:
1 - Major Problems
2 - Poor
3 - Some Problems
4 - Good
5 - Excellent
2
YES YES gender integer Set. Allowed values:
1 - Male
2 - Female
1
YES YES birth_date date YYYY-MM-DD 1982-10-15
YES YES MaritalStatus integer Set. Allowed values:
1 - Single
2 - Married
1
YES YES requested_policy_deductible integer Set. Allowed values:
1 - 100$
2 - 250$
3 - 500$
4 - 1000$
5 - 2500$
1
YES YES requested_policy_liability integer Set. Allowed values:
1 - 100000$
2 - 300000$
3 - 500000$
4 - 1000000$
5 - 5000000$
1
YES YES requested_policy_ReplacementCost integer 300000
YES YES requested_policy_StartDate date YYYY-MM-DD 2021-08-08
YES YES claim2
complementary datas are requireds if claim2 is sent and ≠ 0
display complementary datas
 integer Set. Allowed values:
0 - no
1 - yes
0
YES YES claim3
complementary datas are requireds if claim3 is sent and ≠ 0
display complementary datas
 integer Set. Allowed values:
0 - no
1 - yes
0
YES YES property_zip varchar(5) 33139
YES YES property_city varchar(50) Miami
YES YES property_state varchar(2) FL
YES YES ownership Set. Allowed values:
1 - Own
2 - Rent
3 - Live With Parents
4 - Dormitory
5 - Choice Not Listed
2
YES YES OccupiedByApplicant integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES Occupancy_number integer 3
YES YES years_at_current_residence integer 3
YES YES home_value integer 250000
YES YES construction_class integer Set. Allowed values:
1 - Standard
2 - Luxury
3 - Economical
4 - Manufactured
3
YES YES construction_type integer Set. Allowed values:
1 - Wood Frame
2 - All Brick
3 - More than 50% Brick
4 - Metal Frame
5 - Masonry

show all 		2
YES YES square_feet integer 1240
YES YES new_home integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES bedrooms integer 3
YES YES bathrooms integer 2
YES YES foundation integer Set. Allowed values:
1 - Basement
2 - Concrete Slab
3 - Crawl Space
4 - Slab Cement Solid
5 - Piers Pilings Stilts

show all 		1
YES YES garage integer Set. Allowed values:
1 - No Garage
2 - Carport
3 - Attached - 1 Car
4 - Attached - 2 Cars
5 - Attached - 3 Cars

show all 		1
YES YES stories_number integer Set. Allowed values:
1 - 1
2 - 1 1/2
3 - 2
4 - 3
5 - 4

show all 		3
YES YES RoofAge integer
in years 		14
YES YES roofing_type integer Set. Allowed values:
1 - Asphalt Shingle
2 - Metal
3 - Wood Shingle
4 - Tile Shingle
5 - Clay

show all 		6
YES YES exterior_walls integer Set. Allowed values:
1 - Mostly Brick
2 - Mostly Wood Frame
3 - Mostly Stone
4 - Aluminum Siding
5 - Vinyl Siding

show all 		5
YES YES heating_type integer Set. Allowed values:
1 - Gas Forced Air
2 - Boiler
3 - Oil
4 - Propane
5 - Electric

show all 		5
YES YES WiringType integer Set. Allowed values:
1 - Copper
2 - Aluminum
3 - KnobAndTube
4 - Unknown
1
YES YES panel_type integer Set. Allowed values:
1 - Circuit Breaker
2 - Fuse Box
3 - Other
1
YES YES central_air_conditioning integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES copper_water_pipes integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES DeckPatio integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES fireplaces integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES InGroundPool integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES PoolFence integer Set. Allowed values:
1 - Yes
2 - No
2
YES YES HotTub integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES Sauna integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES Trampoline integer Set. Allowed values:
1 - Yes
2 - No
2
YES YES smoke_alarm integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES fire_alarm integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES indoor_sprinklers integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES fire_hydrant_within_1000_feet integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES proximity_fire_station integer Set. Allowed values:
1 - Not Applicable
2 - Within 1,000 Feet
3 - Within 1 Mile
4 - Within 5 Miles
3
YES YES FireExtinguishers integer Set. Allowed values:
1 - Yes
2 - No
2
YES YES WoodBurningStove integer Set. Allowed values:
1 - Yes
2 - No
2
YES YES SmokerInHousehold integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES PropertyInFloodplain integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES proximity_water integer Set. Allowed values:
1 - Not Applicable
2 - Within 1,000 Feet
3 - Within 1 Mile
4 - Within 5 Miles
2
YES YES Sumppump integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES brush_hazard_within_500_feet integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES home_security integer Set. Allowed values:
1 - No
2 - Home Only
3 - Monioring Company
2
YES YES AudioAlarmOnly integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES DeadboltLocks integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES MonitoredAlarmSystem integer Set. Allowed values:
1 - Yes
2 - No
1
YES YES education integer Set. Allowed values:
1 - Less than High School
2 - Some or No High School
3 - High School Diploma
4 - Some College
5 - College

show all 		3
YES YES occupation integer Set. Allowed values:
1 - Government
2 - Health Care
3 - Homemaker
4 - Hospitality/Travel
5 - Human Resources

show all 		12
YES YES years_at_previous_residence integer 5
YES YES dogBreed integer Set. Allowed values:
1 - None
2 - Doberman
3 - German Shepherd
4 - Pit Bull
5 - Rottweiler
1
YES YES requested_policy_coverage_type integer Set. Allowed values:
1 - Full Coverage
2 - Fire and Liability
3 - Liability Only
3
YES YES state varchar(2)
registrant’s state 		FL
NO YES property_address varchar(255) 1210 Ocean Drive
NO YES firstname varchar(50) John
NO YES lastname varchar(50) Doe
NO YES email varchar(50) john.doe@gmail.com
NO YES telephone varchar(20) 8772681223
NO YES address varchar(255) 1210 Ocean Drive
NO OPTION comments varchar(500) Free comment
NO OPTION customid varchar(50) - Your custom Id 12345
NO OPTION city varchar(50) Miami
OPTION NO trusted_form_available 1 (Yes) 1 (for Yes) or 0 (for No)
OPTION NO universal_leadid_available 1 (Yes) 1 (for Yes) or 0 (for No)
OPTION OPTION lead_born_datetime Y-m-d h:i:s 2023-01-01 11:50:23
OPTION OPTION trusted_form_token varchar(250) 544fa56524d00e3a0cb321b988fc40d8c42c7160
OPTION OPTION universal_leadid varchar(50) AB6A63B1-09A6-5AA3-85BD-CBDA909D9BBE
OPTION OPTION 1to1consent
complementary datas are requireds if 1to1consent is sent and ≠ 0
display complementary datas
 0 (No), 1 (Yes). 0 by default 0
OPTION OPTION year_upgraded integer 2018
OPTION OPTION NumberUnits integer 2
OPTION OPTION DeckPatio_is_covered integer Set. Allowed values:
1 - Yes
2 - No
1
OPTION OPTION IsMilitary integer Set. Allowed values:
1 - Yes
2 - No
1
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.
    TEST MODE
    Only For test Mode please :
  • use key = test_mode (The Live Mode Key will be provided upon completion of successful Test.)
  • use subid = match To simulate a positive response
    • For direct post according to a ziplist
  • add price = 0.5
    • #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, .

    • jerems17