BigDataCloud Logo
Documentation Pricing
Login
< Back to Documentation
On this page
Introduction
Get Started
Endpoint
Request
Responses

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 package 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.bigdatacloud.net/data/phone-number-validate-by-ip

Request

Parameter
Type
Required
Description
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. 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

Example query 

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

Example response

  • 1
    {
  • 2
    "isValid": true,
  • 3
    "e164Format": "+61884633490",
  • 4
    "internationalFormat": "+61 8 8463 3490",
  • 5
    "nationalFormat": "(08) 8463 3490",
  • 6
    "location": "Adelaide",
  • 7
    "lineType": "FIXED_LINE",
  • 8
    "country": {...}
    • 9
      "isoAlpha2": "AU",
    • 10
      "isoAlpha3": "AUS",
    • 11
      "m49Code": 36,
    • 12
      "name": "Australia",
    • 13
      "isoName": "Australia",
    • 14
      "isoNameFull": "Australia",
    • 15
      "isoAdminLanguages": [...]
      • 16
        {...}
        • 17
          "isoAlpha3": "eng",
        • 18
          "isoAlpha2": "en",
        • 19
          "isoName": "English",
        • 20
          "nativeName": "English"
        • 21
          }
      • 22
        ],
    • 23
      "unRegion": "Oceania/Australia and New Zealand",
    • 24
      "currency": {...}
      • 25
        "numericCode": 36,
      • 26
        "code": "AUD",
      • 27
        "name": "Australian Dollar",
      • 28
        "minorUnits": 2
      • 29
        },
    • 30
      "wbRegion": {...}
      • 31
        "id": "EAS",
      • 32
        "iso2Code": "Z4",
      • 33
        "value": "East Asia & Pacific"
      • 34
        },
    • 35
      "wbIncomeLevel": {...}
      • 36
        "id": "HIC",
      • 37
        "iso2Code": "XD",
      • 38
        "value": "High income"
      • 39
        },
    • 40
      "callingCode": "61",
    • 41
      "countryFlagEmoji": "🇦🇺",
    • 42
      "wikidataId": "Q408",
    • 43
      "geonameId": 2077456,
    • 44
      "continents": [...]
      • 45
        {...}
        • 46
          "continent": "Oceania",
        • 47
          "continentCode": "OC"
        • 48
          }
      • 49
        ]
    • 50
      }
  • 51
    }

Schema

application/json