Phone Validation
Validity, carrier, line type, porting, DNC status and a risk level for any number.
curl -X POST https://api.1lookup.dev/v1/phone-validation \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+15125550142"}'{
"success": true,
"data": {
"phone_number": "+15125550142",
"valid": true,
"line_type": "mobile",
"carrier": {
"name": "Example Wireless",
"ocn": "6010",
"lrn": "+15125550000",
"ported": true
},
"location": {
"city": "Austin",
"state": "TX",
"country": "US",
"timezone": "America/Chicago"
},
"dnc": {
"listed": false,
"dno": false
},
"risk": {
"level": "low",
"factors": []
}
},
"meta": {
"credits_used": 1,
"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. US and Canada get carrier and DNC data. Other countries get format, country and line type. 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.validbooleanWhether the number is a real, assignable number in its numbering plan.
data.line_typestringmobile, landline, voip, toll_free or unknown, so you know if it can receive SMS.
data.carrier.namestringThe carrier serving the number today, after any porting.
data.carrier.portedbooleanWhether the number moved from the carrier that was first assigned it.
data.dnc.listedbooleanWhether a US number appears on the National Do Not Call registry.
data.risk.levelstringlow, medium or high, with the factors that produced it.
data.locationobjectCity, state, country and time zone tied to the number's rate center.
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
1 credit. 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