Skip to main content

Phone Number Validator is a simple tool for validating if a phone number is valid or not. It checks the phone number format and the country code to see if the phone number is valid.

Project description

Phone Number Validator API

Phone Number Validator is a simple tool for validating if a phone number is valid or not. It checks the phone number format and the country code to see if the phone number is valid.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Phone Number Validator API


Installation

Using pip:

pip install apiverve-phonenumbervalidator

Using pip3:

pip3 install apiverve-phonenumbervalidator

Configuration

Before using the phonenumbervalidator API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient

# Initialize the client with your APIVerve API key
api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]")

query = {
    "number": "816-555-1017",
    "country": "us"
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Phone Number Validator API documentation is found here: https://docs.apiverve.com/ref/phonenumbervalidator. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient

# Initialize the client with your APIVerve API key
api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "number": "816-555-1017",
    "country": "us"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "country": "US",
    "detectedCountry": "US",
    "countrycode": 1,
    "numberNational": 8165551017,
    "extension": null,
    "isvalid": true,
    "type": "fixed_line_or_mobile",
    "formatted": {
      "international": "+1 816-555-1017",
      "national": "(816) 555-1017",
      "rfc": "tel:+1-816-555-1017",
      "e164": "+18165551017"
    }
  }
}

Error Handling

The API client provides comprehensive error handling through the PhonenumbervalidatorAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient, PhonenumbervalidatorAPIClientError

api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]")

query = {
    "number": "816-555-1017",
    "country": "us"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except PhonenumbervalidatorAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient, PhonenumbervalidatorAPIClientError

api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]")

query = {
    "number": "816-555-1017",
    "country": "us"
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except PhonenumbervalidatorAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient, PhonenumbervalidatorAPIClientError

query = {
    "number": "816-555-1017",
    "country": "us"
}

# Using context manager ensures proper cleanup
with PhonenumbervalidatorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except PhonenumbervalidatorAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient

# Enable debug mode
api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "number": "816-555-1017",
    "country": "us"
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_phonenumbervalidator.apiClient import PhonenumbervalidatorAPIClient

api = PhonenumbervalidatorAPIClient("[YOUR_API_KEY]")

query = {
    "number": "816-555-1017",
    "country": "us"
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_phonenumbervalidator-1.1.14.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_phonenumbervalidator-1.1.14-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_phonenumbervalidator-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_phonenumbervalidator-1.1.14.tar.gz
Algorithm Hash digest
SHA256 5a899414e7cc33412910c830c50538221a4d08e8eb7449f50fbaa9f602623b3e
MD5 564e89969f076647f55fd35e13c7dfcc
BLAKE2b-256 781128204f5485492a2430bcad40635b21c6e473c434fef63687a4e0ba44ae54

See more details on using hashes here.

File details

Details for the file apiverve_phonenumbervalidator-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_phonenumbervalidator-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 4f1859fc4b4cb18fe7ea373f0b6ee230b2b06b955f8770c636997d49ff2fa178
MD5 0a8e329d0efd0a1f0e3823a9b290e29c
BLAKE2b-256 71986d260ac8dfd9c41f8a2cecf0614185892c7fb305715a072f7995412f6e16

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page