Ping & Post Instructions
for Legal
Let's Make A Lead API
Please use the following instructions to use our Ping/Post or Direct Post system for Legal Vertical.
In order to get identified, you will need to send the following parameters:
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 |
2019 - Family Law - Divorce 2020 - Family Law - Child Custody 2021 - Family Law - Child Support 2022 - Family Law - Adoption 2023 - Family Law show all |
2001 |
| 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 |
Fields Required for Legal
| Ping Required |
Post Required |
fieldname | Value - Label | Example of value | |
|---|---|---|---|---|---|
| YES | YES | tcpa_optin | 1 (Yes) or 2 (No) Set. Allowed values: 1 - Yes 2 - No |
1 | |
| YES | YES | incident_timeframe 💡Requiered for categories : 2001 - Auto Accidents 2017 - DUI 2031 - Medical Malpractice 2032 - Mesothelioma 2033 - Nursing Home Abuse 2034 - Personal Injury 2041 - Workers Comp |
integer Set. Allowed values: 1 - Recently 2 - 3-6 months ago 3 - 6-12 months ago 4 - More than 1 year ago 5 - More than 2 years ago |
3 | |
| YES | YES | was_it_your_fault 💡Requiered for categories : 2001 - Auto Accidents |
integer Set. Allowed values: 1 - Yes 2 - No |
2 | |
| YES | YES | doctor_treatment 💡Requiered for categories : 2001 - Auto Accidents 2013 - Criminal Defense - Police Brutality 2031 - Medical Malpractice 2032 - Mesothelioma 2033 - Nursing Home Abuse 2034 - Personal Injury 2037 - SSDI or Social Security Disability 2041 - Workers Comp |
integer Set. Allowed values: 1 - yes 2 - no |
1 | |
| YES | YES | spoke_to_attorney | integer Set. Allowed values: 1 - Yes 2 - No |
2 | |
| YES | YES | zipcode | varchar(5) | 33139 | |
| NO | YES | tcpa_text | varchar(5000) | The TCPA Text of the Lead | |
| NO | YES | issue_description | varchar(5000) | ex. I need an attorney to help me with my divorce. | |
| NO | YES | firstname | varchar(50) | John | |
| NO | YES | lastname | varchar(50) | Doe | |
| NO | YES | varchar(50) | johndoe@gmail.com | ||
| NO | YES | telephone | varchar(50) | 8772681223 | |
| NO | YES | address | varchar(100) | 1210 Ocean Drive | |
| NO | YES | city | varchar(100) | Miami | |
| NO | NO | applied_previously 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer Set. Allowed values: 1 - Yes, claim denied 2 - Yes, claim pending 3 - No |
1 | |
| NO | NO | assets 💡Requiered for categories : 2002 - Bankruptcy |
integer Set. Allowed values: 1 - less than 50K 2 - 50K-100K 3 - 100K-250K 4 - 250K-500K 5 - 500K-1M show all |
2 | |
| NO | NO | benefits 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| NO | NO | condition 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer Set. Allowed values: 1 - less than 1 year 2 - 1-3 Years 3 - 3-5 Years 4 - 5 Years |
1 | |
| NO | NO | date_exposition 💡Requiered for categories : 2052 - Mass Tort - Camp Lejeune |
date YYYY-MM-DD | 1960-01-01 | |
| NO | NO | debt 💡Requiered for categories : 2002 - Bankruptcy 2038 - Tax Law |
integer Set. Allowed values: 1 - less than 5K 2 - 5K-10K 3 - 10K-20K 4 - 20K-50K 5 - 50K |
4 | |
| NO | NO | exposition 💡Requiered for categories : 2052 - Mass Tort - Camp Lejeune |
integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| NO | NO | hours_reduced 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer Set. Allowed values: 1 - Yes 2 - No |
2 | |
| NO | NO | immigration_status 💡Requiered for categories : 2026 - Immigration |
integer Set. Allowed values: 1 - Living in the US with proper docs 2 - Living in the US without proper docs 3 - Living outside the USA 4 - Currently facing deportation |
1 | |
| NO | NO | immigration_type 💡Requiered for categories : 2026 - Immigration |
integer Set. Allowed values: 1 - Citizenship 2 - Permanent Visa 3 - Temporary Visa 4 - Deportation 5 - Other |
1 | |
| NO | NO | income_monthly 💡Requiered for categories : 2002 - Bankruptcy |
integer Set. Allowed values: 1 - less than 1K 2 - 1K-2K 3 - 2K-3K 4 - 3K-5K 5 - 5K-7K show all |
3 | |
| NO | NO | injured_diagnosis 💡Requiered for categories : 2052 - Mass Tort - Camp Lejeune |
integer Set. Allowed values: 1 - Bladder Cancer 2 - Breast Cancer 3 - Esophageal Cancer 4 - Kidney Cancer 5 - Leukemia show all |
10 | |
| NO | NO | level_tax 💡Requiered for categories : 2038 - Tax Law |
integer Set. Allowed values: 1 - State 2 - Federal 3 - Local |
2 | |
| NO | NO | property_owner 💡Requiered for categories : 2002 - Bankruptcy 2024 - Foreclosure Defense |
integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| NO | NO | shared complementary datas are requireds if shared is sent and ≠ 0  display complementary datas |
1 (Yes) Set. Allowed values: 1 - shared lead 2 - exclusive lead |
0 | |
| NO | NO | total_tax_debt 💡Requiered for categories : 2038 - Tax Law |
integer Set. Allowed values: 1 - less than 5K 2 - 5K-10K 3 - 10K-20K 4 - 20K-50K 5 - 50K |
2 | |
| NO | NO | type_tax 💡Requiered for categories : 2038 - Tax Law |
integer Set. Allowed values: 1 - Income 2 - Property 3 - Corporate |
1 | |
| NO | NO | user_age 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer | 43 | |
| NO | NO | work_status 💡Requiered for categories : 2037 - SSDI or Social Security Disability |
integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| OPTION | YES | ip | varchar(50) | 213.36.145.10 | |
| OPTION | YES | phone_type | integer Set. Allowed values: 1 - Mobile 2 - Non-Mobile |
1 | |
| 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 | state | varchar(2) | FL | |
| 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 | damages | integer Set. Allowed values: 1 - 1K 2 - 1K-2K 3 - 2K-3K 4 - 3K-5K 5 - 5K-7K show all |
5 | |
| OPTION | OPTION | police_report_filed | integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| OPTION | OPTION | were_you_injured | integer Set. Allowed values: 1 - Yes 2 - No |
1 | |
| OPTION | OPTION | attorney_payment | integer Set. Allowed values: 1 - Can afford 2 - Can't afford |
2 | |
| OPTION | OPTION | best_time | varchar(50) Set. Allowed values: 1 - Morning 2 - Evening 3 - Anytime |
2 |
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.
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 |
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, .
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: