BigDataCloud Logo

Phone Number Validation by IP Address API

Introduction

This API provides a similar validation check as the Phone Number Validation API by using the user’s IP address.

This API can be useful when you want to avoid asking for too many input parameters from a user during form submission.

Get Started

This API is part of the Phone number and Email verification and is available in free and paid plans. Please visit the Phone number and Email verification package page for limits and pricing information.

Endpoint

GET
https://api-bdc.net/data/phone-number-validate-by-ip

Request

Parameter
number
Type
string
Required
Yes
Description
Phone number to validate
Parameter
ip
Type
string
Required
Optional, default value: [Caller's IP]
Description
IPv4 IP address in a string or numeric format or IPv6 IP address in a string format. If omitted, the caller’s IP address is assumed
Parameter
localityLanguage
Type
string
Required
Optional, default value: en
Description
Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. If the requested language is not available for a requested location, it will default to English. If no English variant is known, will provide the native, local names
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

200
OK

Sample Query

GET
https://api-bdc.net/data/phone-number-validate-by-ip?number=884633490&ip=193.114.112.1&localityLanguage=en&key=[YOUR API KEY]

Schema

application/json
isValidboolean
Indicates whether the number is valid
e164Formatstring
The number formatted in E164 standard format
internationalFormatstring
The number formatted in International dial format
nationalFormatstring
The number formatted in local dial format
locationstring
Estimated location localised to the language as defined by 'localityLanguage' request parameter
lineTypestring
Line type detected. Possible values are: 'FIXED_LINE', 'MOBILE', 'FIXED_LINE_OR_MOBILE', 'TOLL_FREE', 'PREMIUM_RATE', 'SHARED_COST', 'VOIP', 'PERSONAL_NUMBER', 'PAGER', 'UAN', 'VOICEMAIL', 'UNKNOWN'
country
country object
isoAlpha2string
ISO 3166-1 Alpha-2 code
isoAlpha3string
ISO 3166-1 Alpha-3 code
m49Codeinteger
United Nations M.49 code
namestring
Country name localised to the language as defined by 'localityLanguage' request parameter
isoNamestring
ISO 3166-1 Country name short
isoNameFullstring
ISO 3166-1 Country name full
isoAdminLanguagesarray
Administrative languages as defined by ISO 3166-1 standard
isoAlpha3string
ISO 3166-1 Alpha-3 code
isoAlpha2string
ISO 3166-1 Alpha-2 code
isoNamestring
ISO 3166-1 Language name
nativeNamestring
A native name
unRegionstring
Region name as defined by the United Nations
currency
currency object
numericCodeinteger
ISO 4217 standard numeric code
codestring
ISO 4217 standard code
namestring
ISO 4217 English name
minorUnitsinteger
ISO 4217 minor units as the currency exponent (e.g. 2 = 1/100)
wbRegion
wbRegion object
idstring
world bank identification number. the expected values are: 'LCN','NA','SAS','SSF','ECS','MEA','EAS','NAC'
iso2Codestring
iso 2 letters code. the expected values are: 'ZJ','NA','8S','ZG','Z7','ZQ','Z4','XU'
valuestring
region name. the expected values are: 'Latin America & Caribbean','Aggregates','South Asia', 'Sub-Saharan Africa','Europe & Central Asia','Middle East & North Africa','East Asia & Pacific','North America'
wbIncomeLevel
wbIncomeLevel object
idstring
world bank identification number. the expected values are: 'HIC','NA','LIC','LMC','UMC','INX'
iso2Codestring
iso 2 letters code. the expected values are: 'XD','NA','XM','XN','XT','XY'
valuestring
income level name. the expected values are: 'High income','Aggregates','Low income','Lower middle income','Upper middle income','Not classified'
callingCodestring
Calling code
countryFlagEmojistring
Country emoji
wikidataIdstring
Wikidata item identifier, if available
geonameIdinteger
A unique identifier as is given by GeoNames.org
isIndependentboolean
Determines if the country/territory is independent according to ISO 3166 records

Sample Response

JSON View
403
Access denied, or your quota limit has exceeded

Sample Response

JSON View
404
Found no valid entry for the request

Sample Response

JSON View
405
The requested IP address is not valid

Sample Response

JSON View
500
An error has occurred and did not complete your request. Please try again

Sample Response

JSON View
Was this page helpful?