API Specification

API Function - pingPostLead

This function has three modes.

Ping mode: in "ping" mode you can submit partial lead information as defined in "Ping Required" column of the specification to check if lead can be matched.
Post mode: Based on the "ping" response (matched, unmatched) you can then post the full lead info. Required fields are defined in "Post Required" column of the specification.
Full mode: This mode can be used if one has the full lead and would like to submit it just once but system still does ping and then post steps internally. In this case the lead must contain all required values for ping and for post mode, except Lead_ID.
Cost: optionally, a lead cost can be submitted in the ping request. It then overrides lead cost values in the system. Cost should be sent only in ping mode, in post mode it is ignored. It is also ignored if equal or less then zero value is sent.

Its inputs depend on the lead type configuration. Click on the lead type link to view respective function specification.

Spec URL: https://example.leadprosper.tech/boberdoo/ping-post Provide this link to the Seller

When buying leads on a ping post basis you will need to provide the Seller with the following in addition to these Specs:

SRC: Source of the lead
Seller API Key: Identifies the Seller passing the request

Information on how to find or create each of these values can be found on this page: https://www.boberdoo.com/buying-ping-post-leads/.

Leadtype: Legal

Ping Required	Post Required	Field name	Values	Example
NO	NO	Format	string (format for response - JSON or XML), default XML	JSON
YES	YES	Key	created under Settings > API Keys What is an API Key?	***
YES	YES	API_Action	name of the API function to call	pingPostLead
YES	YES	Mode	string, one of: ping post full	ping
NO	NO	Cost	real number greater than 0	2.55
NO	YES	Lead_ID	Lead ID number received in response of "ping" mode.	1234
NO	NO	Allowed_Times_Sold	Max. number of times a lead can be sold.	2
NO	NO	Return_Hash_Type	Hashes of the matches sent back in response. Must be used together with Return_Hash_Value_Type Allowed values: *sha1, md5, plain ()*. () except email and phone	sha1
NO	NO	Return_Hash_Value_Type	Hashes of the matches sent back in response. Must be used together with Return_Hash_Type Allowed values: email, phone, company, promotionCode, partnerGroup	email
NO	NO	Skip_Partner_ID	List the partners to skip in processing (exclude from being matched). Comma delimited list of values.	142,1543,225
YES	NO	Return_Best_Price	1 (Only if vendor is on dynamic pricing)	1
NO	NO	SRC_ID	Source ID, if provided then SRC is not required	123
YES	YES	TYPE	34	34
NO	NO	Test_Lead	1 (Only when testing)	1
NO	NO	Skip_XSL	Do not include XSL path in XML response	1
NO	NO	Match_With_Partner_ID	Comma separeated list with Buyer IDs to only match with	22,456
NO	NO	Redirect_URL	Set your redirect URL.	http://www.yoursite.com
YES	YES	SRC	Assigned by lead company	test
NO	NO	Sub_ID	Varchar (100)	12
NO	NO	Pub_ID	Varchar (100)	12345
NO	NO	Optout	Varchar (20)	Optout
NO	NO	Unique_Identifier	Varchar (40)	Unique_Identifier
NO	NO	TCPA_Optin	Set. Allowed values: Yes No	Yes
NO	NO	first_name	Varchar (100)	John
NO	NO	last_name	Varchar (100)	Doe
NO	NO	phone_home	Valid phone. 10 digits	3125556811
NO	NO	phone_cell	Valid phone. 10 digits	3125556811
NO	NO	phone_work	Valid phone. 10 digits	3125556811
NO	NO	phone_ext	Valid phone. 10 digits	3125556811
NO	NO	address	Varchar (100)	123 Main St.
NO	NO	address2	Varchar (100)	123 Main St.
NO	NO	city	Varchar (100)	Chicago
YES	YES	state	Valid US state abbreviation. Varchar (2)	IL
YES	YES	zip_code	Valid Zip. 5 digits	60610
NO	NO	county	Varchar (100)	Cook County
NO	NO	country	Varchar (100)	U.S.
NO	YES	email_address	Valid email. Varchar (100)	[email protected]
NO	NO	dob	Valid date. m/d/Y	12/23/1980
YES	YES	ip_address	Varchar (100)	75.2.92.149
NO	NO	type_of_legal_problem	Varchar (100)	Type Of Legal Problem
YES	YES	have_attorney	Set. Allowed values: Yes No	Yes
NO	NO	business_owner	Varchar (100)	Yes
NO	NO	owns_real_estate	Varchar (100)	Yes
NO	NO	total_assets_value	Varchar (100)	20
NO	NO	monthly_income	Set. Allowed values: Less than 1K 1K to 2K 2K to 3K 3K to 4K 4K to 5K 5K to 7K 7K to 10K 10K to 15K More than 15K	Less than 1K
NO	NO	total_debt	Varchar (100)	30000
YES	YES	injury	Varchar (100)	Yes
NO	NO	trusted_form_certid	Varchar (100)	Trusted form cert id
NO	NO	injury_type	Varchar (100)	Anxiety
NO	NO	gender	Varchar (100)	Male
NO	NO	user_agent	Varchar (100)	User Agent
NO	NO	trustedform_url	Varchar (100)	trustedform_url
NO	NO	universal_leadid	Varchar (100)	universal lead id
NO	NO	tcpa	Varchar (500)	tcpa
NO	NO	fault	Set. Allowed values: Yes No	Yes
NO	NO	attorney	Varchar (100)	Attorney
NO	NO	doctor_treatment	Set. Allowed values: Yes No	Yes
NO	NO	comments	Varchar (2500)	Comments
NO	NO	incident_date	Valid date. m/d/Y	12/23/1980
NO	YES	landing_url	Site where lead form completed	Landing Page

You can send the data as XML or JSON post. You can send the XML or JSON data to the following URLs.

XML Post URL: https://example.leadprosper.tech/boberdoo/apiXML.php

JSON Post URL: https://example.leadprosper.tech/boberdoo/apiJSON.php

All required values are being evaluated as stated in the table above.

Note: To use the Matches and/or Match_With_Partner_Hashes functionality, you must use the XML Post method of this API.

Tag Name	Description	Note
Data	Put appropriate lead data tags	The set of data tags depends on lead type
Matches	Matches made by vendor	When you sold the lead already put information about your matches here. This section is not required.
Match	Information about your match	Put hashed or unhashed value of the phone or email or company, etc.
ValueType	The property of Match tag	Description of data type provided. Allowed values: email, phone, company, promotionCode, partnerGroup (use group ID for partnerGroup)
HashType	The property of Match tag	Description of hash type provided. Allowed values: sha1, md5.
Match_With_Partner_Hashes	Request to match the lead with specific partners	Hashes must be selected from the list of hashes provided in ping response when using Return Hashes option. HashType and ValueType of the Selected_Partner_Hash tag must be the same as used in the Return Hashes option in ping.
Selected_Partner_Hash	The hash of a partner a lead is requested to be matched with	Hash must be selected from the list of hashes provided on ping when using Return Hashes option
HashType	The property of Selected_Partner_Hash tag	Description of hash type provided. Allowed values: sha1, md5.
ValueType	The property of Selected_Partner_Hash tag	Description of data type provided. Allowed values: email, phone, company, promotionCode, partnerGroup (use group ID for partnerGroup)

XML Post

<?xml version="1.0" encoding="utf-8"?>
<Request>
  <Key/>
  <API_Action/>
  <Mode/>
  <Cost/>
  <Allowed_Times_Sold/>
  <Return_Hash_Type/>
  <Return_Hash_Value_Type/>
  <Lead_ID/>
  <Skip_Partner_ID/>
  <TYPE/>
  <Skip_XSL/>
  <Match_With_Partner_ID/>
  <Redirect_URL/>
  <Data>
    <SRC/>
    <Sub_ID/>
    <Pub_ID/>
    <Optout/>
    <Unique_Identifier/>
    <TCPA_Optin/>
    <first_name/>
    <last_name/>
    <phone_home/>
    <phone_cell/>
    <phone_work/>
    <phone_ext/>
    <address/>
    <address2/>
    <city/>
    <state/>
    <zip_code/>
    <county/>
    <country/>
    <email_address/>
    <dob/>
    <ip_address/>
    <type_of_legal_problem/>
    <have_attorney/>
    <business_owner/>
    <owns_real_estate/>
    <total_assets_value/>
    <monthly_income/>
    <total_debt/>
    <injury/>
    <trusted_form_certid/>
    <injury_type/>
    <gender/>
    <user_agent/>
    <trustedform_url/>
    <universal_leadid/>
    <tcpa/>
    <fault/>
    <attorney/>
    <doctor_treatment/>
    <comments/>
    <incident_date/>
    <landing_url/>
  </Data>
  <Matches>
    <Match ValueType="promotionCode" HashType="plain">test code</Match>
    <Match ValueType="promotionCode" HashType="plain">12345</Match>
  </Matches>
  <Match_With_Partner_Hashes>
    <Selected_Partner_Hash ValueType="company" HashType="md5">ewd5692602fc4sa545e4feb0ew3964c5</Selected_Partner_Hash>
    <Selected_Partner_Hash ValueType="company" HashType="md5">f26e492602fc4b4077feb0d80d3964c5</Selected_Partner_Hash>
  </Match_With_Partner_Hashes>
</Request>

JSON Post

{
    "Request": {
        "Key": "",
        "API_Action": "",
        "Mode": "",
        "Cost": "",
        "Allowed_Times_Sold": "",
        "Return_Hash_Type": "",
        "Return_Hash_Value_Type": "",
        "Lead_ID": "",
        "Skip_Partner_ID": "",
        "TYPE": "",
        "Skip_XSL": "",
        "Match_With_Partner_ID": "",
        "Redirect_URL": "",
        "SRC": "",
        "Sub_ID": "",
        "Pub_ID": "",
        "Optout": "",
        "Unique_Identifier": "",
        "TCPA_Optin": "",
        "first_name": "",
        "last_name": "",
        "phone_home": "",
        "phone_cell": "",
        "phone_work": "",
        "phone_ext": "",
        "address": "",
        "address2": "",
        "city": "",
        "state": "",
        "zip_code": "",
        "county": "",
        "country": "",
        "email_address": "",
        "dob": "",
        "ip_address": "",
        "type_of_legal_problem": "",
        "have_attorney": "",
        "business_owner": "",
        "owns_real_estate": "",
        "total_assets_value": "",
        "monthly_income": "",
        "total_debt": "",
        "injury": "",
        "trusted_form_certid": "",
        "injury_type": "",
        "gender": "",
        "user_agent": "",
        "trustedform_url": "",
        "universal_leadid": "",
        "tcpa": "",
        "fault": "",
        "attorney": "",
        "doctor_treatment": "",
        "comments": "",
        "incident_date": "",
        "landing_url": ""
    }
}

Response Matched Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>Matched</status>
	<lead_id>874</lead_id>
	<price>25</price>
</response>

JSON

{
  "response": {
    "status": "Matched",
    "lead_id": "874",
    "price": "25"
  }
}

Response Matched Example with Allowed_Times_Sold used

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>Matched</status>
	<lead_id>874</lead_id>
	<matches>5</matches>
</response>

JSON

{
  "response": {
    "status": "Matched",
    "lead_id": "874",
    "matches": "5"
  }
}

Response Matched Example with sent back hashes

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>Matched</status>
	<lead_id>348</lead_id>
	<hashes>
		<hash HashType="md5" ValueType="email">8561c83bb23a3f77345fa2b6b50b1f4e</hash>
		<hash HashType="md5" ValueType="email">8561c83bb23a3f77345fa2b6b50b1f4e</hash>
	</hashes>
</response>

JSON

{
  "response": {
    "status": "Matched",
    "lead_id": "348",
    "hashes": {
      "hash": [
        {
          "@HashType": "md5",
          "@ValueType": "email",
          "0": "8561c83bb23a3f77345fa2b6b50b1f4e"
        },
        {
          "@HashType": "md5",
          "@ValueType": "email",
          "0": "8561c83bb23a3f77345fa2b6b50b1f4e"
        }
      ]
    }
  }
}

Response Unmatched Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>Unmatched</status>
	<lead_id>874</lead_id>
</response>

JSON

{
  "response": {
    "status": "Unmatched",
    "lead_id": "874"
  }
}

Name	Description	Note
status	Status
lead_id	ID number of successfully submitted lead	Returned on success
price	The best price at which a lead can be accepted.	Returned on success and only if Return_Best_Price was submitted in "ping"

Response - error

XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>Error</status>
	<error>Required value first_name is missing</error>
</response>

JSON

{
  "response": {
    "status": "Error",
    "error": "Required value first_name is missing"
  }
}

Name	Description	Note
error	Error message	Returned on error
status	Status