PX Open API Ping Post – Full shared

Introduction

This document describes how to post full shared life 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/lead/ping

Post URL: https://leadapi.px.com/api/lead/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.

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


Ping
<?xml version="1.0" encoding="UTF-8"?>
<Lead>
    <ApiToken>XXXXX</ApiToken>
    <Vertical>Life</Vertical>
    <SubId>FB1</SubId>
    <Sub2Id></Sub2Id>
    <Sub3Id></Sub3Id>
    <Sub4Id></Sub4Id>
    <Sub5Id></Sub5Id>
    <UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.101 Safari/537.36</UserAgent>
    <OriginalUrl>www.exampleURL.com</OriginalUrl>
    <Source>Social</Source>
    <JornayaLeadId></JornayaLeadId>
    <TrustedForm></TrustedForm>
    <SessionLength>38</SessionLength>
    <TcpaText>By clicking Get My Quotes, I authorize security companies, their dealers and partner companies to contact me about security offers by phone calls and text messages to the number I provided. I authorize that these marketing communications may be delivered to me using an automatic telephone dialing system or by prerecorded message. I understand that my consent is not a condition of purchase</TcpaText>
    <VerifyAddress>false</VerifyAddress>
    <ContactData>
	<ZipCode>90100</ZipCode>
        <State>NY</State>
        <IpAddress>255.255.255.127</IpAddress>
        <YearsAtResidence>1</YearsAtResidence>
        <MonthsAtResidence>4</MonthsAtResidence>
        <ResidenceType>My own house</ResidenceType>
    </ContactData>
    <Custom>
        <Field1>Free text</Field1>
        <Field2>Free text</Field2>
        <Field3>Free text</Field3>
        <Field4>Free text</Field4>
        <Field5>Free text</Field5>
        <Field6>Free text</Field6>
        <Field7>Free text</Field7>
        <Field8>Free text</Field8>
        <Field9>Free text</Field9>
	<Field10>Free text</Field10>
    </Custom>
    <Person>
        <Id>1</Id>
        <BirthDate>1980-09-09</BirthDate>
        <Gender>Male</Gender>
        <MaritalStatus>Married</MaritalStatus>
        <RelationshipToApplicant>Self</RelationshipToApplicant>
        <CreditRating>Good</CreditRating>
        <DeniedInsurance>No</DeniedInsurance>
        <Height_FT>5</Height_FT>
        <Height_Inch>9</Height_Inch>
        <Weight>200</Weight>
        <Occupation>Employeed</Occupation>
        <Education>Bachelors Degree</Education>
        <Medication>No</Medication>
        <Children>None</Children>
        <LifeStyle>
            <LicenseEverSuspendedRevoked>Yes</LicenseEverSuspendedRevoked>
            <HazardousActivities>No</HazardousActivities>
            <DUI>Yes</DUI>
        </LifeStyle>
        <PreExistingConditions>None</PreExistingConditions>
        <Conditions>
            <HighCholesterol>No</HighCholesterol>
            <Ulcers>No</Ulcers>
            <VascularDisease>No</VascularDisease>
            <AIDSHIV>No</AIDSHIV>
            <Arthritis>No</Arthritis>
            <Asthma>No</Asthma>
            <Cancer>No</Cancer>
            <Depression>No</Depression>
            <Diabetes>No</Diabetes>
            <HeartDisease>No</HeartDisease>
            <Hepatitis>No</Hepatitis>
            <HighBloodPressure>No</HighBloodPressure>
            <MentalIllness>No</MentalIllness>
            <Stroke>No</Stroke>
            <Other>No</Other>
        </Conditions>
        <MedicalHistory>
            <Hospitalized>No</Hospitalized>
            <FamilyHistoryHeartDisease>No</FamilyHistoryHeartDisease>
            <FamilyHistoryCancer>No</FamilyHistoryCancer>
            <Smoker>Yes</Smoker>
        </MedicalHistory>
    </Person>
    <CurrentInsurancePolicy>
        <InsuranceCompany>Allstate</InsuranceCompany>
        <ExpirationDate>2022-01-04</ExpirationDate>
        <InsuredSince>2021-01-01</InsuredSince>
    </CurrentInsurancePolicy>
	<RequestedInsurancePolicy>
        <CoverageType>Term</CoverageType>
		<CoverageTerm>5 years</CoverageTerm>
		<CoverageAmount>25,000</CoverageAmount>
    </RequestedInsurancePolicy>
   <Distribution>
      <OpenSlots>5</OpenSlots>
   </Distribution>
</Lead>
Post
<?xml version="1.0" encoding="UTF-8" ?>
<Lead>
    <ApiToken>XXXXX</ApiToken>
    <Vertical>Life</Vertical>
    <SubId>FB1</SubId>
    <Sub2Id></Sub2Id>
    <Sub3Id></Sub3Id>
    <Sub4Id></Sub4Id>
    <Sub5Id></Sub5Id>
    <UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.101 Safari/537.36</UserAgent>
    <OriginalUrl>www.exampleURL.com</OriginalUrl>
    <Source>Social</Source>
    <JornayaLeadId></JornayaLeadId>
    <TrustedForm></TrustedForm>
    <SessionLength>38</SessionLength>
    <TcpaText>By clicking Get My Quotes, I authorize security companies, their dealers and partner companies to contact me about security offers by phone calls and text messages to the number I provided. I authorize that these marketing communications may be delivered to me using an automatic telephone dialing system or by prerecorded message. I understand that my consent is not a condition of purchase</TcpaText>
    <VerifyAddress>false</VerifyAddress>
  <TransactionId>XXXXX</TransactionId>
  <ContactData>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <Address>Wall st. 5</Address>
    <City>New York</City>
    <State>NY</State>
    <ZipCode>90100</ZipCode>
    <EmailAddress>testlead@somedomain.com</EmailAddress>
    <PhoneNumber>6543218454</PhoneNumber>
    <DayPhoneNumber>6543218454</DayPhoneNumber>
    <IpAddress>255.255.255.127</IpAddress>
    <YearsAtResidence>1</YearsAtResidence>
    <MonthsAtResidence>4</MonthsAtResidence>
    <ResidenceType>My own house</ResidenceType>
  </ContactData>
  <Custom>
        <Field1>Free text</Field1>
        <Field2>Free text</Field2>
        <Field3>Free text</Field3>
        <Field4>Free text</Field4>
        <Field5>Free text</Field5>
        <Field6>Free text</Field6>
        <Field7>Free text</Field7>
        <Field8>Free text</Field8>
        <Field9>Free text</Field9>
	<Field10>Free text</Field10>
  </Custom>
  <Person>
        <Id>1</Id>
        <BirthDate>1980-09-09</BirthDate>
        <Gender>Male</Gender>
        <MaritalStatus>Married</MaritalStatus>
        <RelationshipToApplicant>Self</RelationshipToApplicant>
        <CreditRating>Good</CreditRating>
        <DeniedInsurance>No</DeniedInsurance>
        <Height_FT>5</Height_FT>
        <Height_Inch>9</Height_Inch>
        <Weight>200</Weight>
        <Occupation>Employeed</Occupation>
        <Education>Bachelors Degree</Education>
        <Medication>No</Medication>
        <Children>None</Children>
        <LifeStyle>
            <LicenseEverSuspendedRevoked>Yes</LicenseEverSuspendedRevoked>
            <HazardousActivities>No</HazardousActivities>
            <DUI>Yes</DUI>
        </LifeStyle>
        <PreExistingConditions>None</PreExistingConditions>
        <Conditions>
            <HighCholesterol>No</HighCholesterol>
            <Ulcers>No</Ulcers>
            <VascularDisease>No</VascularDisease>
            <AIDSHIV>No</AIDSHIV>
            <Arthritis>No</Arthritis>
            <Asthma>No</Asthma>
            <Cancer>No</Cancer>
            <Depression>No</Depression>
            <Diabetes>No</Diabetes>
            <HeartDisease>No</HeartDisease>
            <Hepatitis>No</Hepatitis>
            <HighBloodPressure>No</HighBloodPressure>
            <MentalIllness>No</MentalIllness>
            <Stroke>No</Stroke>
            <Other>No</Other>
        </Conditions>
        <MedicalHistory>
            <Hospitalized>No</Hospitalized>
            <FamilyHistoryHeartDisease>No</FamilyHistoryHeartDisease>
            <FamilyHistoryCancer>No</FamilyHistoryCancer>
            <Smoker>Yes</Smoker>
        </MedicalHistory>
  </Person>
  <CurrentInsurancePolicy>
        <InsuranceCompany>Allstate</InsuranceCompany>
        <ExpirationDate>2022-01-04</ExpirationDate>
        <InsuredSince>2021-01-01</InsuredSince>
  </CurrentInsurancePolicy>
	<RequestedInsurancePolicy>
        <CoverageType>Term</CoverageType>
	<CoverageTerm>5 years</CoverageTerm>
	<CoverageAmount>25,000</CoverageAmount>
  </RequestedInsurancePolicy>
 <Distribution>
      <Include>
         <Directive>
            <Name>Leg2</Name>
         </Directive>
      </Include>
 </Distribution>
</Lead>

Ping
{
        "ApiToken": "XXXXX",
        "Vertical": "Life",
        "SubId": "FB1",
        "Sub2Id": "",
        "Sub3Id": "",
        "Sub4Id": "",
        "Sub5Id": "",
	"OriginalUrl": "https://www.exampleURL.com",
	"Source": "Social",
	"JornayaLeadId": "",
        "TrustedForm":"",
	"SessionLength": "38",
	"TcpaText": "By clicking Get My Quotes, I authorize insurance companies, their dealers and partner companies to contact me about life insurance offers by phone calls and text messages to the number I provided. I authorize that these marketing communications may be delivered to me using an automatic telephone dialing system or by prerecorded message. I understand that my consent is not a condition of purchase",
	"VerifyAddress": "false",
	"ContactData": {
		"ZipCode": "90100",
		"State": "NY",
		"IpAddress": "255.255.255.127",
        "YearsAtResidence": "1",
        "MonthsAtResidence": "4",
        "ResidenceType":""
    },
    	"Custom": {
		"Field1": "Free text",
		"Field2": "Free text",
		"Field3": "Free text",
		"Field4": "Free text",
		"Field5": "Free text",
		"Field6": "Free text",
		"Field7": "Free text",
		"Field8": "Free text",
		"Field9": "Free text",
		"Field10": "Free text"
	},
    "Person": {
        "Id": "1",
        "BirthDate": "1980-09-09",
        "Gender": "Male",
        "MaritalStatus": "Married",
        "RelationshipToApplicant": "Self",
        "CreditRating": "Good",
        "DeniedInsurance": "No",
        "Height_FT": "5",
        "Height_Inch": "9",
        "Weight": "200",
        "Occupation": "Employeed",
        "Education": "Bachelors Degree",
        "Medication": "No",
        "Children": "None",
        "LifeStyle": {
            "LicenseEverSuspendedRevoked": "Yes",
            "HazardousActivities": "No",
            "DUI": "Yes"
        },
        "PreExistingConditions": "None",
        "Conditions": {
            "HighCholesterol": "No",
            "Ulcers": "No",
            "VascularDisease": "No",
            "AIDSHIV": "No",
            "Arthritis": "No",
            "Asthma": "No",
            "Cancer": "No",
            "Depression": "No",
            "Diabetes": "No",
            "HeartDisease": "No",
            "Hepatitis": "No",
            "HighBloodPressure": "No",
            "MentalIllness": "No",
            "Stroke": "No",
            "Other": "No"
        },
        "MedicalHistory": {
            "Hospitalized": "No",
            "FamilyHistoryHeartDisease": "No",
            "FamilyHistoryCancer": "No",
            "Smoker": "Yes"
        }
    },
    "CurrentInsurancePolicy": {
        "InsuranceCompany": "Allstate",
        "ExpirationDate": "2022-01-04",
        "InsuredSince": "2021-01-01"
    },
    "RequestedInsurancePolicy": {
        "CoverageType": "Term",
        "CoverageTerm": "5 years",
        "CoverageAmount": "25,000"
    },
	"Distribution": {
		"OpenSlots": "5"
	}
}
}

Post

{
        "ApiToken": "XXXXX",
        "Vertical": "Life",
        "SubId": "FB1",
        "Sub2Id": "",
        "Sub3Id": "",
        "Sub4Id": "",
        "Sub5Id": "",
	"OriginalUrl": "https://www.exampleURL.com",
	"Source": "Social",
	"JornayaLeadId": "",
        "TrustedForm":"",
	"SessionLength": "38",
	"TcpaText": "By clicking Get My Quotes, I authorize security companies, their dealers and partner companies to contact me about security offers by phone calls and text messages to the number I provided. I authorize that these marketing communications may be delivered to me using an automatic telephone dialing system or by prerecorded message. I understand that my consent is not a condition of purchase",
	"VerifyAddress": "false",
	"TransactionId": "XXXXX",
	"ContactData": {
		"ZipCode": "90100",
		"State": "NY",
		"Address": "Wall st. 5",
		"IpAddress": "255.255.255.127",
		"FirstName": "John",
		"LastName": "Doe",
		"City": "New York",
		"EmailAddress": "testlead@somedomain.com",
		"PhoneNumber": "6543218454",
		"DayPhoneNumber": "6543218454",
        "YearsAtResidence": "1",
        "MonthsAtResidence": "4",
        "ResidenceType":"My own house"
    },
    	"Custom": {
		"Field1": "Free text",
		"Field2": "Free text",
		"Field3": "Free text",
		"Field4": "Free text",
		"Field5": "Free text",
		"Field6": "Free text",
		"Field7": "Free text",
		"Field8": "Free text",
		"Field9": "Free text",
		"Field10": "Free text"
	},
    "Person": {
        "Id": "1",
        "BirthDate": "1980-09-09",
        "Gender": "Male",
        "MaritalStatus": "Married",
        "RelationshipToApplicant": "Self",
        "CreditRating": "Good",
        "DeniedInsurance": "No",
        "Height_FT": "5",
        "Height_Inch": "9",
        "Weight": "200",
        "Occupation": "Employeed",
        "Education": "Bachelors Degree",
        "Medication": "No",
        "Children": "None",
        "LifeStyle": {
            "LicenseEverSuspendedRevoked": "Yes",
            "HazardousActivities": "No",
            "DUI": "Yes"
        },
        "PreExistingConditions": "None",
        "Conditions": {
            "HighCholesterol": "No",
            "Ulcers": "No",
            "VascularDisease": "No",
            "AIDSHIV": "No",
            "Arthritis": "No",
            "Asthma": "No",
            "Cancer": "No",
            "Depression": "No",
            "Diabetes": "No",
            "HeartDisease": "No",
            "Hepatitis": "No",
            "HighBloodPressure": "No",
            "MentalIllness": "No",
            "Stroke": "No",
            "Other": "No"
        },
        "MedicalHistory": {
            "Hospitalized": "No",
            "FamilyHistoryHeartDisease": "No",
            "FamilyHistoryCancer": "No",
            "Smoker": "Yes"
        }
    },
    "CurrentInsurancePolicy": {
        "InsuranceCompany": "Allstate",
        "ExpirationDate": "2022-01-04",
        "InsuredSince": "2021-01-01"
    },
    "RequestedInsurancePolicy": {
        "CoverageType": "Term",
        "CoverageTerm": "5 years",
        "CoverageAmount": "25,000"
    },
	"Distribution": {
		"Include": [{
			"Name": "Leg12"
		}]
	}
}

Fields Table

Parameter	Required Ping	Required Post	Accepted Values	Description (data type)
ApiToken	Yes	Yes	Provided by PX	GUID format
Vertical	Yes	Yes	Life	String
SubId	Yes	Yes	Format provided at start	String
Sub2Id	No	No		String
Sub3Id	No	No		String
Sub4Id	No	No		String
Sub5Id	No	No		String
UserAgent	Yes	Yes		String
OriginalURL	Yes	Yes	URL where the lead is from	String
Source	Yes	Yes	Discuss with Acc. Manager	String
JornayaLeadId	Yes	Yes	Jornaya LeadId (GUID format)	See link on how to implement on form
Trustedform	No	No	TrustedForm Cert. URL	See link on how to implement on form
ClickConsentID	No	No		Integer
SessionLength	Yes	Yes	Amount of time spent by the user to fill out the form in seconds	String
TcpaText	Yes	Yes	Consent language	String
VerifyAddress	No	No	True / False	String
TransactionId	No	Yes	Retrieve from Ping Response	GUID format
FirstName	No	Yes		String
LastName	No	Yes		String
Address	No	Yes		String
City	No	Yes		String
State	Yes	Yes	See accepted values list	String
ZipCode	Yes	Yes	5 digit zip code	String
EmailAddress	No	Yes	Valid email address	String
PhoneNumber	No	Yes	Valid 10 digit phone number without formatting 8887777777	String
DayPhoneNumber	No	Yes	Valid 10 digit phone number without formatting 8887777777	String
IpAddress	Yes	Yes	Example: 38.88.150.2	String
YearsAtResidence	No	No	See accepted values	String
MonthsAtResidence	Yes	Yes		String
ResidenceType	Yes	Yes	Dorm / Student housing / I am renting / My own house / Other /	String
Field1	No	No	Free text field	String
Field2	No	No	Free text field	String
Field3	No	No	Free text field	String
Field4	No	No	Free text field	String
Field5	No	No	Free text field	String
Field6	No	No	Free text field	String
Field7	No	No	Free text field	String
Field8	No	No	Free text field	String
Field9	No	No	Free text field	String
Field10	No	No	Free text field	String
BirthDate	Yes	Yes	yyyy-MM-dd	String
Gender	Yes	Yes	Male / Female / Unspecified	String
MaritalStatus	Yes	Yes	Divorced / Married / Separated / Single / Widowed	String
RelationshipToApplicant	Yes	Yes	See accepted values	String
CreditRating	Yes	Yes	Excellent / Good / Some Problems / Major Problems	String
DeniedInsurance	Yes	Yes	Yes/No	String
Height_FT	Yes	Yes	Height in feet (1-9)	String
Height_Inch	Yes	Yes	Height in inches (0-11)	String
Weight	Yes	Yes	Weight in pounds	String
Occupation	Yes	Yes	See accepted values	String
Education	Yes	Yes	See accepted values	String
Medication	Yes	Yes	Yes / No	String
Children	Yes	Yes	None, 1, 2, 3, 4, 5, 5+	String
LicenseEverSuspendedRevoked	Yes	Yes	Yes / No	String
HazardousActivities	Yes	Yes	Yes / No	String
DUI	Yes	Yes	Yes / No	String
PreExistingConditions	Yes	Yes	Yes / None	String
HighCholesterol	Yes	Yes	Yes / No	String
Ulcers	Yes	Yes	Yes / No	String
VascularDisease	Yes	Yes	Yes / No	String
AIDSHIV	Yes	Yes	Yes / No	String
Arthritis	Yes	Yes	Yes / No	String
Asthma	Yes	Yes	Yes / No	String
Cancer	Yes	Yes	Yes / No	String
Depression	Yes	Yes	Yes / No	String
Diabetes	Yes	Yes	Yes / No	String
HeartDisease	Yes	Yes	Yes / No	String
Hepatitis	Yes	Yes	Yes / No	String
HighBloodPressure	Yes	Yes	Yes / No	String
MentalIllness	Yes	Yes	Yes / No	String
Stroke	Yes	Yes	Yes / No	String
Other	Yes	Yes	Yes / No	String
FamilyHistoryHeartDisease	Yes	Yes	Yes / No	String
FamilyHistoryCancer	Yes	Yes	Yes / No	String
Smoker	Yes	Yes	Yes / No	String
Hospitalized	Yes	Yes	Yes / No	String
InsuranceCompany	Yes, if currently insured	Yes, if currently insured	See accepted values	String
ExpirationDate	Yes, if currently insured	Yes, if currently insured	yyyy-MM-dd	String
InsuredSince	Yes, if currently insured	Yes, if currently insured	yyyy-MM-dd	String
CoverageType	Yes	Yes	Term / Whole Life / Universal / Not Sure	String
CoverageTerm	Yes	Yes	5 years / 10 years / 15 years / 20 years / 25 years / 30 years / Not sure	String
CoverageAmount	Yes	Yes	See accepted values	String
OpenSlots	Yes	No		String See explanation on undersold
Include	No	Yes		String See explanation on full shared
Name	Yes, if Hash is not used	Yes, if Hash is not used	Leg name	String See explanation on full shared
Hash	Yes, if Name is not used	Yes, if Name is not used	SHA-1 Hashed leg name	String See explanation on full shared

Responses

PX responds with accurate feedback on how to update your request for it to be accepted by the API.

Success – Ping



{
    "TransactionId": "394d89a8-fae9-4a08-92cd-b5bf97f8455e",
    "Success": true,
    "Payout": null,
    "Message": null,
    "Errors": null,
    "Sold": null,
    "RedirectUrl": null,
    "BuyerRawResponse": null,
    "Environment": "Testing",
    "Legs": [
        {
            "Name": null,
            "Hash": "462c49f8-9288-4d7a-aab6-48a6406a0d82",
            "Payout": 12.34,
            "Status": "Success"
        },
        {
            "Name": null,
            "Hash": "cb3be58b-ef2f-4b5d-8418-e68f3c5872ee",
            "Payout": 23.45,
            "Status": "Success"
        },
        {
            "Name": null,
            "Hash": "303e7ec3-589f-497e-9107-2c04efaac98e",
            "Payout": 34.56,
            "Status": "Success"
        }
    ]
}


<?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>643fd719-bd29-4825-b859-e172bc31acf1</TransactionId>
   <Success>true</Success>
   <Payout xsi:nil="true" />
   <Sold xsi:nil="true" />
   <Environment>Testing</Environment>
   <Legs>
      <Leg>
         <Hash>f37eff48-6f79-4174-b770-9c6ed7166d1f</Hash>
         <Payout>12.34</Payout>
         <Status>Success</Status>
      </Leg>
      <Leg>
         <Hash>adc73637-6c51-446d-8b03-c1ef1d7aa94e</Hash>
         <Payout>23.45</Payout>
         <Status>Success</Status>
      </Leg>
      <Leg>
         <Hash>df053300-a1cc-4e4b-8423-4abcca644e72</Hash>
         <Payout>34.56</Payout>
         <Status>Success</Status>
      </Leg>
   </Legs>
</Result>

Success – Post


{
    "TransactionId": "394d89a8-fae9-4a08-92cd-b5bf97f8455e",
    "Success": true,
    "Payout": null,
    "Message": null,
    "Errors": null,
    "Sold": null,
    "RedirectUrl": null,
    "BuyerRawResponse": null,
    "Environment": "Testing",
    "Legs": [
        {
            "Name": null,
            "Hash": "ebd3d4aa-d3dc-448a-9947-034b1dbd3c65",
            "Payout": 12.34,
            "Status": "Success"
        },
        {
            "Name": null,
            "Hash": "3d4c2e34-17d9-4c65-9094-9aa6682f6a82",
            "Payout": 23.45,
            "Status": "Success"
        },
        {
            "Name": null,
            "Hash": "7940786d-5f2d-48f4-a896-9bd53bb9c6f8",
            "Payout": 34.56,
            "Status": "Success"
        }
    ]
}


<?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>790B52B0-FE5D-48E3-B81C-91992017A659</TransactionId>
   <Success>true</Success>
   <Payout xsi:nil="true" />
   <Sold xsi:nil="true" />
   <Environment>Testing</Environment>
   <Legs>
      <Leg>
         <Hash>e3f54b53-39f0-4fd7-ad9c-3786ba5cafc1</Hash>
         <Payout>12.34</Payout>
         <Status>Success</Status>
      </Leg>
      <Leg>
         <Hash>764d649e-0c7f-4274-8558-3aba963c28e2</Hash>
         <Payout>23.45</Payout>
         <Status>Success</Status>
      </Leg>
      <Leg>
         <Hash>be713280-abb4-4975-8c78-ae2921a4cc9c</Hash>
         <Payout>34.56</Payout>
         <Status>Success</Status>
      </Leg>
   </Legs>
</Result>

Failure


{
    "TransactionId": "49CE4DB7-775B-405B-BBBD-B23FB003073A",
    "Success": false,
    "Payout": null,
    "Message": "BadRequest",
    "Errors": [
        
    ]
    "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>
      
   </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.

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

Occupation

Employeed
Government
Homemaker
Retired
Student Living w/ Parents
Student not Living w/ Parents
Unemployed
Military
Retail
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

CoverageAmount

25,000
50,000
75,000
100,000
200,000
500,000
1,000,00
5,000,000

InsuranceCompany

Allstate
American General
Aviva
Banner Life
Fidelity Life
Genworth Financial
Great West Life
Hartford Life
ING
John Hancock
Legal & General
Lincoln National
Massachusetts Mutual (Mass Mutual)
MetLife
Mutual of Omaha
New York Life
Northwestern Mutual
Pacific Life
Prudential
Transamerica
Company not listed
Currently not insured

RelationshipToApplicant

Self
Spouse
Child
Sibling
Parent
Grandparent
Grandchild
Other

YearsAtResidence

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.

Full Shared

PX provides you with the ability to sell us a specific leg only. On the ping response we will tell you the bid per every leg (by name or hashed), and, in the response, should this price be satisfactory for you, you can initiate the post and thus selling us that leg – all through one API ping/post call.

Parameters explained

OpenSlots – This indicates how many times the lead can still be sold by PX
Include/Exclude – What action will PX take on this lead? For Full Shared it will always be include since we are including this buyer in the bidding process.
Name – This is the leg name of the buyer.
Hash – This is the hashed leg name of the buyer. Hashing is done using the
SHA-1 hashing method. The hashed value needs to be the buyer’s 1800 phone number.

Full Shared Lead Flow

Publisher pings PX with a ping request
PX responds with bids per buyer
Publisher decides which buyers to include on the post and forms the post request including the buyer’s leg / hashed leg names
PX responds with the result of the sale per leg name.

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

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

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

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