DNC Scrub
Do Not Call status, known-litigator flag and line type in one compliance check.
curl -X POST https://api.1lookup.dev/v1/dnc-scrub \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+15125550142"}'{
"success": true,
"data": {
"phone_number": "+15125550142",
"national_dnc": {
"listed": true
},
"state_dnc": {
"state": "TX",
"available": true,
"listed": false
},
"litigator": {
"flagged": false
},
"line_type": "mobile",
"recommendation": "do_not_call",
"reasons": [
"national_dnc_listed"
]
},
"meta": {
"credits_used": 10,
"credits_remaining": 999,
"cached": false,
"request_id": "req_8f3a2c1e9b7d"
}
}Authorization
Authorizationstring<bearer>requiredYour API key as a Bearer token. Live keys start with 1lk_live_. Test keys start with 1lk_test_ and return this endpoint's sample response without spending credits. See authentication.
Body
Send the fields as a JSON object with Content-Type: application/json.
phone_numberstring<E.164>requiredPhone number. Example: +15125550142
freshbooleanSkip the 7-day cache and run a new lookup. Charged as a normal lookup.
referencestringYour own identifier, echoed back in meta and shown in lookup history.
Response
A 200 response carries the result in data and the cost of the call in meta. These are the fields most integrations read.
successbooleantrue when the lookup ran.
data.national_dnc.listedbooleanWhether the number is on the National Do Not Call registry.
data.state_dnc.availablebooleanWhether the number's state has its own Do Not Call list that could be checked.
data.state_dnc.listedbooleanWhether the number appears on that state list.
data.litigator.flaggedbooleantrue when the number matches a known TCPA litigator.
data.line_typestringmobile, landline or voip, because calling rules differ for wireless numbers.
data.recommendationstringcall or do_not_call, a summary of the checks above.
data.reasonsarrayThe specific findings behind the recommendation, as codes you can store.
meta.credits_usednumberCredits charged for this call.
meta.credits_remainingnumberYour balance after the call.
meta.cachedbooleantrue when the result came from the 7-day cache.
meta.request_idstringQuote this when you contact support.
Errors
A failed request returns success: false with an error object, and is never charged. The full list is on the errors page.
| HTTP | Code | Meaning |
|---|---|---|
| 401 | unauthorized | The key is missing, malformed or revoked. |
| 402 | insufficient_credits | Your credits are used up and pay as you go is off or at its limit. |
| 422 | invalid_input | A field is missing or malformed. The field property names it. |
| 429 | rate_limited | Too many requests for this key. Wait for the Retry-After interval. |
| 500 | internal_error | Something failed on our side. Safe to retry. |
| 503 | source_unavailable | An upstream source did not answer in time. Safe to retry. |
Billing
10 credits. Charged when the lookup runs and returns a result. Errors are never charged, and repeating the same input within 7 days is served from cache at no charge.
Product overview and use cases