
Ping & Post Instructions
for Finance / Debt
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 |
4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage 4005 - Payday Loans show all |
4001 |
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 |
Ping Required |
Post Required |
fieldname | Value - Label | Example of value | |
---|---|---|---|---|---|
YES | YES | agent_found 💡Requiered for categories : 4001 - New Purchase |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
YES | YES | bankruptcy 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage 4006 - Auto Finance |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
YES | YES | buy_timeframe 💡Requiered for categories : 4001 - New Purchase |
Set. Allowed values: 1 - Immediately 2 - Up to 30 days 3 - Up to 60 days 4 - Up to 90 days 5 - No time constraint |
1 | |
YES | YES | credit_rating 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage 4006 - Auto Finance |
Set. Allowed values: 1 - Excellent 2 - Good 3 - Fair 4 - Poor |
1 | |
YES | YES | down_payment 💡Requiered for categories : 4001 - New Purchase 4006 - Auto Finance |
integer | 15 | |
YES | YES | employment_type 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Employed 2 - Self Employed 3 - Fixed Income |
1 | |
YES | YES | first_balance 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
integer | 100000 | |
YES | YES | income 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
integer | 10000 | |
YES | YES | in_military 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage 4005 - Payday Loans |
Set. Allowed values: 1 - yes 2 - no |
1 | |
YES | YES | loan_amount 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage 4005 - Payday Loans |
integer | 100000 | |
YES | YES | property_city 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
varchar(50) | Miami | |
YES | YES | property_state 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
varchar(2) | FL | |
YES | YES | property_type 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Single Family 2 - Multi-Family 3 - Condominium 4 - Town House 5 - Mobile Home show all |
1 | |
YES | YES | property_zip 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
varchar(5) | 33139 | |
YES | YES | second_mortgage 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
YES | YES | spec_home 💡Requiered for categories : 4001 - New Purchase |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
YES | YES | zipcode | varchar(5) | 33139 | |
NO | YES | property_street 💡Requiered for categories : 4001 - New Purchase 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
varchar(255) | 1210 Ocean Drive | |
NO | YES | firstname | varchar(50) | John | |
NO | YES | lastname | varchar(50) | Doe | |
NO | YES | address | varchar(100) | 1210 Ocean Drive | |
NO | YES | telephone | varchar(50) | 8772681223 | |
NO | YES | varchar(50) | john.doe@gmail.com | ||
NO | NO | additional_cash 💡Requiered for categories : 4003 - Home Equity Loan |
integer | 30000 | |
NO | NO | bank_account_number 💡Requiered for categories : 4005 - Payday Loans |
integer | 0112345678 | |
NO | NO | bank_account_type 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
Set. Allowed values: 1 - Savings 2 - Checking |
1 | |
NO | NO | bank_foreclosure 💡Requiered for categories : 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
NO | NO | bank_name 💡Requiered for categories : 4005 - Payday Loans |
varchar(255) | Bank of America | |
NO | NO | bank_routing_number 💡Requiered for categories : 4005 - Payday Loans |
varchar(9) | 012345678 | |
NO | NO | birth_date 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance 4007 - Debt |
varchar(50) | 1993-12-23 | |
NO | NO | debt_amount 💡Requiered for categories : 4007 - Debt |
integer | 10000 | |
NO | NO | employer 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
varchar(250) | employer | |
NO | NO | first_interest_rate 💡Requiered for categories : 4002 - Refinance 4003 - Home Equity Loan 4004 - Reverse Mortgage |
varchar(6) | 3.5 | |
NO | NO | home_equity_type 💡Requiered for categories : 4003 - Home Equity Loan |
Set. Allowed values: 1 - Second Mortgage 2 - HELOC 3 - Not Sure |
1 | |
NO | NO | home_value 💡Requiered for categories : 4004 - Reverse Mortgage |
integer | 250000 | |
NO | NO | income_payment_frequency 💡Requiered for categories : 4005 - Payday Loans |
Set. Allowed values: 1 - Weekly 2 - Bi-Weekly 3 - Monthly |
1 | |
NO | NO | income_payment_type 💡Requiered for categories : 4005 - Payday Loans |
Set. Allowed values: 1 - Direct deposit 2 - Check |
1 | |
NO | NO | income_type 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
Set. Allowed values: 1 - Employed 2 - Benefits / Fixed Income 3 - Self Employed 4 - Unemployed |
1 | |
NO | NO | job_title 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
varchar(50) | Job title | |
NO | NO | license_number 💡Requiered for categories : 4005 - Payday Loans |
varchar(10) | S999888801 | |
NO | NO | monthly_income 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance 4007 - Debt |
integer | 3000 | |
NO | NO | next_pay_date1 💡Requiered for categories : 4005 - Payday Loans |
varchar(50) | 2023-02-13 | |
NO | NO | next_pay_date2 💡Requiered for categories : 4005 - Payday Loans |
varchar(50) | 2023-02-13 | |
NO | NO | num_mortgage_lates 💡Requiered for categories : 4004 - Reverse Mortgage |
integer | 0 | |
NO | NO | occupancy 💡Requiered for categories : 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Primary Residence 2 - Secondary Residence 3 - Vacation Property 4 - Rental Property |
1 | |
NO | NO | rate_type 💡Requiered for categories : 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Fixed Rate 2 - Adjustable Rate 3 - Fixed/Adjustable 4 - Fixed Rate 5 - Adjustable Rate show all |
1 | |
NO | NO | residence_type 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
Set. Allowed values: 1 - Own 2 - Rent 3 - Other |
1 | |
NO | NO | ssn 💡Requiered for categories : 4005 - Payday Loans 4006 - Auto Finance |
integer | AAA-GG-SSSS | |
NO | NO | va_loan 💡Requiered for categories : 4004 - Reverse Mortgage |
Set. Allowed values: 1 - Yes 2 - No |
1 | |
NO | NO | work_time_at_employer 💡Requiered for categories : 4005 - Payday Loans |
integer | 16 | |
NO | OPTION | customid | varchar(50) | 12345 | |
OPTION | YES | tcpa_text | varchar(5000) | The TCPA Text of the Lead | |
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 | bank_account_length_months | integer | 20 | |
OPTION | OPTION | bank_phone | integer | 8772681223 | |
OPTION | OPTION | lead_born_datetime | Y-m-d h:i:s | 2023-01-01 11:50:23 | |
OPTION | OPTION | license_state | varchar(2) | FL | |
OPTION | OPTION | loan_purpose | 1 | ||
OPTION | OPTION | ltv_percentage | integer | 95 | |
OPTION | OPTION | months_at_residence 💡Requiered for categories : 4006 - Auto Finance |
integer | 6 | |
OPTION | OPTION | second_balance | integer | 100000 | |
OPTION | OPTION | second_interest_rate | 3 | ||
OPTION | OPTION | state | varchar(2) | FL | |
OPTION | OPTION | tcpa_optin | 1 (Yes) or 2 (No) | 1 | |
OPTION | OPTION | trusted_form_token | varchar(250) | 544fa56524d00e3a0cb321b988fc40d8c42c7160 | |
OPTION | OPTION | years_at_residence 💡Requiered for categories : 4006 - Auto Finance |
integer | 5 | |
OPTION | OPTION | universal_leadid | varchar(50) | AB6A63B1-09A6-5AA3-85BD-CBDA909D9BBE | |
OPTION | OPTION | city | varchar(100) | Miami | |
OPTION | OPTION | comments | varchar(500) | Free comment | |
OPTION | OPTION | ip | varchar(50) | 213.36.145.10 | |
OPTION | OPTION | 1to1consent complementary datas are requireds if 1to1consent is sent and ≠ 0 ![]() |
0 (No), 1 (Yes). 0 by default | 0 | |
OPTION | OPTION | shared complementary datas are requireds if shared is sent and ≠ 0 ![]() |
1 (Yes) | 0 |
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 |
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:
By using the API endpoint
http://call.letsmakealead.com/Ping_Partner_CR.php
, you will receive all the necessary details in one step. Along with the offer and call duration, the response will include the phone number to transfer the call immediately if the offer is accepted.
This saves time and simplifies the process.