Individual Lookup
Check one phone number with your own Phone Validator key. Synchronous, returns the result directly.
POST /validate_phone
Pass a phone number in any format. For numbers outside the US and Canada, include + and the country code.
Headers
Content-Type
application/json
Body
api_key
string
Your API Key.
phone_number
string
The phone number to check, any format. Outside the US and Canada, include + and the country code.
Response
The record is under data. See Response Format for the fields every endpoint returns.
phone_number
string
The number that was checked, echoed back.
phone_type
string
Cell Phone, Landline, VOIP, Toll-Free, Unknown, Fake or Invalid.
phone_company
string
The phone company, for example T-MOBILE.
fake_number
string
Yes or No.
phone_location
string
Where the number was issued, from its area code. Not where the phone is now.
When Phone Validator cannot be reached, only phone_number comes back and message starts with Not checked.
Example
{
"api_key": "your_api_key",
"phone_number": "7029270000"
}{
"status": "success",
"data": {
"phone_number": "7029270000",
"phone_type": "Cell Phone",
"phone_company": "T-MOBILE",
"fake_number": "No",
"phone_location": "LAS VEGAS, NV"
},
"credits_used": 0.0,
"credits_remaining": 4823.0,
"message": "Cell Phone, T-MOBILE. Free in Parvenu credits.",
"success": true
}{
"status": "error",
"error": {
"code": "http_error",
"message": "No Phone Validator key found. Add your key on the Integrations page, then try again.",
"detail": "no_phone_validator_key"
},
"success": false
}With no Phone Validator key saved, the call answers 400 before anything is looked up, and nothing is charged. If Phone Validator refuses your key, your account is inactive or it is out of funds, the call answers 400 with detail set to phone_validator_key_rejected, phone_validator_account_inactive or phone_validator_out_of_funds.
To check every contact in a list in one call instead, use List Lookup.