Client Integration & Developer Documentation. Real-time, automated screening of outbound phone numbers across 8 distinct databases to protect campaigns from TCPA violations.
Access to the Litigation Firewall API requires a client-scoped API Key. This key must be supplied in each request as a custom HTTP header:
All checks must be performed using the following endpoint:
| Header | Type | Required | Description |
|---|---|---|---|
x-api-key |
String | Yes | Your unique client API key (starts with lf_). |
Content-Type |
String | Yes | Must be set to application/json. |
Pass a JSON payload containing the 10-digit US phone number to check:
(843) 968-9323, +18439689323). All formatting spaces, brackets, and country codes (1 or +1) are stripped automatically. The remaining digits must contain exactly 10 digits.
The API returns a JSON response indicating the results of the 8 database lookups.
| API Status | Label | Description |
|---|---|---|
no_match_returned |
No match returned | No selected match was returned by checks that completed successfully. This is not permission to call or text. |
match_returned |
Match returned | One or more selected sources returned a match. Review the source-level result before contact. |
risk_indicator_returned |
Risk indicator returned | A non-registry provider returned a potential risk match. This is an informational indicator, not a legal finding. |
incomplete |
Incomplete screening | A requested check failed, timed out, lacked authorized scope, or returned no usable response. Must not be treated as no-match. |
invalid_input |
Invalid input | The submitted value could not be screened (e.g. malformed phone digits). |
Every submitted phone number is screened simultaneously against 8 specialized protection databases:
In the event of authentication or input errors, standard HTTP status codes and JSON error details are returned:
| Status | Reason | Example Payload |
|---|---|---|
400 Bad Request |
Phone number is missing or does not contain 10 digits. | {"error": "Invalid phone number format."} |
401 Unauthorized |
API Key is missing, invalid, or deleted. | {"error": "Invalid or inactive API key."} |
403 Forbidden |
API Key has been suspended or blocked. | {"error": "API key is blocked."} |
429 Too Many Requests |
Rate limit (requests per min) has been exceeded. | {"error": "Rate limit exceeded. Maximum 60..."} |
502 Bad Gateway |
External verification service temporary error. | {"error": "Failed to communicate with API."} |
Download the full, official PDF documentation version for your development team.
Download Official PDF