Introduction
This document describes how to post calls auto leads to PX using ping post. We accept POST requests in XML and JSON. Follow this article to read how ping post works in PX.Posting URL
Before leads can be posted into PX’s live environment, tests need to be performed to ensure success. For testing purposes, PX will set the publisher campaign to a test mode during the integration. All the tests and responses on these tests can be found in the Test leads report.
Ping URL: https://leadapi.px.com/api/call/ping
Post URL: https://leadapi.px.com/api/call/post
Forcing a success: When 90100 zip code is used in the staging environment, the API will respond with success if the API is configured correctly.
Once a lead has been successfully posted and proper posting is confirmed by PX, leads can be posted to the live environment. To post into the live environment, PX will set the publisher campaign to the production mode after approving the successful test.
SellResponseURL
Our API does not provide info about the lead being sold or not with Direct Post and Call & Lead (Ping Post Call) posts.
If not empty, this is the (Postback) URL, that you specify, that will be called by the API to inform you about the final results of the posted Lead. Please consult this article in our knowledge base to setup the SellResponseURL.
There are 2 ways, depending on the SellResponseURL you specify: ‘standard’ and ‘with variables’.
In ‘standard’ we defined the lay-out. In ‘with variables’ you define the layout using our variable labels enclosed in curly brackets {}.
We will only return the variables that you specify.
standard: {SellResponseURL}TransactionId={transactionid}&Payout={payout}&Result={Result}&Reason={Reason}&Sub2ID={sub2id}
with variables: {SellResponseURL}yourvar={transactionid}&yourvar={payout}&yourvar={Result}&yourvar={Reason}&yourvar={sub2id}
Header Fields Table
| Key | Required | Value |
| Content-Type | Yes | Application/json for JSON requests Application/xml for XML requests |
| Accept | No | Application/json for JSON response Application/xml for XML response |
Examples
Fields Table
PX responds with accurate feedback on how to update your request for it to be accepted by the API.
Success – Ping
{
"TransactionId": "D0447C7B-452B-4F2A-9D7B-F3F72848EEE9",
"Success": true,
"Payout": 8.5,
"Message": null,
"Errors": null,
"Sold": null,
"Environment": "Testing"
}
<?xml version="1.0" encoding="UTF-8"?>
<Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TransactionId>ce34e151-6d00-488d-a465-3fa3cebe7ff9</TransactionId>
<Success>true</Success>
<Payout>8.50</Payout>
<Sold xsi:nil="true" />
<Environment>Testing</Environment>
</Result>
Success – Post
{
"TransactionId": "D0447C7B-452B-4F2A-9D7B-F3F72848EEE9",
"Success": true,
"Payout": 8.50,
"Message": null,
"Errors": null,
"Sold": null,
"RedirectUrl": null,
"BuyerRawResponse": null,
"Environment": "Testing",
"Legs": null
}
<?xml version="1.0" encoding="UTF-8"?>
<Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TransactionId>143E2B7A-73A3-41F4-87DA-DB8E136606B0</TransactionId>
<Success>true</Success>
<Payout>12.34</Payout>
<Sold xsi:nil="true" />
<Environment>Testing</Environment>
</Result>
Failure
{
"TransactionId": "49CE4DB7-775B-405B-BBBD-B23FB003073A",
"Success": false,
"Payout": null,
"Message": "BadRequest",
"Errors": [
"'License Status' must not be empty.",
"'License Status' must be one of Current, Expired, Permit, Suspended. Your value is ''."
]
"Sold": null,
"RedirectUrl": null,
"BuyerRawResponse": null,
"Environment": null,
"Legs": null
}
<?xml version="1.0" encoding="UTF-8"?>
<Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TransactionId>49CE4DB7-775B-405B-BBBD-B23FB003073A</TransactionId>
<Success>false</Success>
<Payout xsi:nil="true" />
<Message>BadRequest</Message>
<Errors>
<string>'License Status' must not be empty.</string>
<string>'License Status' must be one of Current, Expired, Permit, Suspended. Your value is ''.</string>
</Errors>
<Sold xsi:nil="true" />
</Result>
The responses from our API shows if a Ping/Post has been successful or not, and if the lead wasn’t successful, why the Ping/Post has been rejected.
- The “Message” parameter gives a general error code.
- The “Errors” parameter gives the specific cause of the error, such as an invalid or missing value for a specific field.
If the Ping/Post was unsuccessful, the Payout and Sold field will show a “Null” value.
RespondOnNoSale
When this is set to False, the API will NOT perform a callback to your SellResponseURL in case we could not sell the LEAD.
States
| AL | AK | AZ | AR | CA | CO | CT | DE | FL | GA |
| HI | ID | IL | IN | IA | KS | KY | LA | ME | MD |
| MA | MI | MN | MS | MO | MT | NE | NV | NH | NJ |
| NM | NY | NC | ND | OH | OK | OR | PA | RI | SC |
| SD | TN | TX | UT | VT | VA | WA | WV | WI | WY |
Accident.Description
- Collided with another car
- Hit an obstruction. Single car accident
- Hit by another person
- Hit while stopped
- Hit a pedestrian
- Other Unlisted Accident
- Rearended by another person
- VehicleHitProperty
- VehicleDamagedAvoidingAccident
- OtherVehicleHitYours
- AtFaultAccidentNotListed
- NotAtFaultAccidentNotListed
Claim.Description
- Act of Nature
- Car fire
- Flood damage
- Hail damage
- Hit an animal
- Other Unlisted Claim
- Theft of stereo
- Theft of vehicle
- Towing service
- Vandalism
- Windshield Replacement
- AutoCylinders
BodilyInjury
- 25/50
- 50/100
- 100/300
- 250/500
- 300,000
- 500,000
Occupation
- Employeed
- Government
- Homemaker
- Retired
- Student Living w/ Parents
- Student not Living w/ Parents
- Unemployed
- Sales
- Marketing
- IT
- Medical
- Unknown
- BusinessOwner
- Student
- SalesInside
- SalesOutside
- Scientist
- OtherTechnical
- MilitaryEnlisted
- Architect
- Other
Education
- Bachelors Degree
- Doctorate Degree
- High school diploma
- Masters Degree
- Other
- None
- Some College
- Associate Degree
- Marketing
- IT
- Medical
- Unknown
- BusinessOwner
- Student
- SalesInside
- SalesOutside
- Scientist
- OtherTechnical
- MilitaryEnlisted
- Architect
- Other
OneWayDistance
- 0
- 1-3
- 4-5
- 6-9
- 10-19
- 20-49
- 50+
PrimaryUse
- Commute To/From Work
- Commute To/From School
- Business Individual
- Business Corporate
- Pleasure
- Farm
- Government
InsuranceCompany
- 21st Century Insurance
- AAA
- AIG
- Alfa Insurance
- Allied
- Allstate
- American Alliance Insurance
- American Deposit Insurance
- American Family
- American Family Insurance
- American Home Assurance
- American International Insurance
- American International Pacific
- American Motorists Insurance
- American National
- American Premier Insurance
- American Protection Insurance
- American Skyline Insurance
- Amica
- Arbella
- Assurant
- Atlanta Casualty
- Atlantic Indemnity
- Auto Club Insurance Company
- Owners Insurance
- Bristol West Insurance
- California State Automobile Association
- Chubb
- Citizens
- Clarendon Insurance
- Clearcover
- CNA
- Company not listed
- Cotton States
- COUNTRY Financial
- Country Insurance and Financial Services
- CSE Insurance Group
- Currently not insured
- Dairyland Insurance
- Direct auto
- Electric Insurance
- Elephant Insurance
- Encova Insurance
- Erie Insurance
- Esurance
- Farm Bureau
- Farmers
- Foremost
- GAINSCO
- Geico
- Guaranty National Insurance
- Hanover Insurance Group
- Hugo Insurance
- Infinity Insurance
- Kemper
- Leader Insurance
- Liberty Mutual
- MAPFRE Insurance
- Maryland Casualty
- Mercury Insurance
- MetLife Auto and Home
- Mid Century Insurance
- Mile Auto
- National General Insurance
- National Union Fire Insurance
- Nationwide
- NJM Insurance
- Omni Insurance
- Orion Insurance
- Pacific Insurance
- Pafco General Insurance
- Patriot General Insurance
- Peak Property and Casualty Insurance
- PEMCO Insurance
- Plymouth Rock Assurance
- Progressive
- Prudential Guarantee
- Republic Indemnity
- Response Insurance
- Root Insurance
- SafeAuto
- SAFECO Insurance
- Safeway Insurance
- Security Insurance
- Sentinel Insurance
- Sentry Insurance
- Shelter Insurance
- St. Paul Insurance
- State Farm
- Stillwater Insurance
- The General
- The Hartford
- Titan
- Travelers Insurance
- Twin City Fire Insurance
- Unitrin Direct (now Kemper Direct)
- USAA
- USF&G (United States Fidelity and Guaranty)
- Viking Insurance
- Wawanesa Insurance
- Western Mutual
- Windsor Insurance
- Zurich North America
RelationshipToApplicant
- Self
- Spouse
- Child
- Sibling
- Parent
- Grandparent
- Grandchild
- Other
YearsAtResidence
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 15
- 20
- 25
- 30
Violation.Description
- Careless driving
- Carpool lane violation
- Child not in car seat
- Defective Equipment
- Defective vehicle (reduced violation)
- Driving without a license
- Excessive noise
- Exhibition driving
- Expired drivers license
- Expired emmissions
- Expired Registration
- Failure to obey traffic signal
- Failure to signal
- Failure to stop
- Failure to yield
- Following too close
- Illegal lane change
- Illegal passing
- Illegal turn
- Illegal turn on red
- Illegal U Turn
- Inattentive driving
- No helmet
- No insurance
- No seatbelt
- Passing a school bus
- Passing in a no-passing zone
- Passing on shoulder
- Ran a red light
- Ran a stop sign
- Reckless driving
- Reckless endangerment
- Wrong way on a one way
- Other Unlisted Moving Violation
- Driving too fast for conditions
MajorViolation.Description
- DUI/DWAI
- License was suspended
- Minor in possession
- Open container
- Drug possession
- DrivingWhileUnderTheInfluenceOfDrugs
- DrivingUnderInfluenceOfAlcolholOrWhileIntoxicated
- DrivingUnderInfluenceOfAlcolholOrWhileIntoxicated
Implementing Jornaya LeadId
To start generating the Jornaya LeadId token on your leads from your page, a script needs to be added to your website. Follow the guidance on how to implement this script.
Implementing TrustedForm
To start generating the TrustedForm CertURL on your leads from your page, a script needs to be added to your website. Follow the guidance on how to implement this script.
Lost bids
This request is initiated after the ping response is received and instructs our API what price the lead has been sold when our bid was lower. This helps us and our lead buyers to optimize the bids.
Lost bids Post URL: https://secureopenapi.px.com/px
Code examples
Post
<?xml version="1.0" encoding="utf-8"?>
<LeadData Target="Lead.RejectWinner" Partner="{Username}" Password="{password}" AffiliateId="{PublisherID}">
<Payout>{payout}</Payout>
<TransactionId>{TransactionId}</TransactionId>
</LeadData>
Post
{
"type": "jsonwsp/request",
"version": "1.0",
"methodname": "Lead.RejectWinner",
"LeadData":
{
"Target" : "Lead.RejectWinner",
"Partner" : "{Username}",
"Password" : "{Password}",
"AffiliateId" : "{PublisherID}",
"Payout" : "{Payout}",
"TransactionId" : "{TransactionId}"
}
}
In addition, HTTP format can be used:
Post
https://secureopenapi.px.com/px?Command=HTTPPost&Target=Lead.RejectWinner&Partner={Username}&Password={Password}&AffiliateId={PublisherID}&Payout={Payout}&TransactiondId={TransactionId} |
Fields table
| Parameter | Explanation | Description (data type) |
| Target=”Lead.RejectWinner” | This indicates that my system needs to treat this request as a price update and not a normal lead | String |
| Partner | The username used to login the account, specifically the account for this campaign (Not MasterAccount) | String |
| Password | The password used to login the account, specifically the account for this campaign (Not MasterAccount) | |
| AffiliateId | The publisherID provided at the start of the integration | String |
| Payout | The price you sold the lead for to another buyer / the price we lost the lead to | String |
| TransactionId | The same as you would on the post. We return a TransactionId on the ping and you return this here to match ping with the lost bid. Should you have problems retrieving our TransactionId from the response it is also possible to parse your own unique id on the ping in the TransactionId parameter. | String |