README

The phone-validator-php library uses the official GenderAPI Phone Number Validation & Formatter API to validate and format phone numbers from over 240 countries.

Whether your users enter phone numbers in various formats (e.g., 12128675309, +1 212 867 5309, 001-212-867-5309), this library will intelligently detect, validate, and convert the input into a standardized E.164 format (e.g., +12128675309).

✅ Features

• Converts phone numbers to E.164 format
• Validates if number is real and structurally possible
• Detects number type: mobile, landline, VoIP, etc.
• Identifies region/city based on area code
• Includes country-level metadata (e.g. ISO code)
• Built with PHP, works with Composer autoloading

📦 Installation

composer require genderapi/phone-validator

Or manually:

git clone https://github.com/GenderAPI/phone-validator-php.git
cd phone-validator-php
composer install

🚀 Usage

require_once __DIR__ . '/vendor/autoload.php';

use GenderApi\PhoneValidator;

$validator = new PhoneValidator('YOUR_API_KEY');

$response = $validator->validate('+1 212 867 5309', 'US');

print_r($response);

📝 Input Parameters

validate(string $number, string|null $address = null): array

Example:

$validator->validate('2128675309', 'US');

📤 API Response

{
  "status": true,
  "remaining_credits": 15709,
  "expires": 0,
  "duration": "18ms",
  "regionCode": "US",
  "countryCode": 1,
  "country": "United States",
  "national": "(212) 867-5309",
  "international": "+1 212-867-5309",
  "e164": "+12128675309",
  "isValid": true,
  "isPossible": true,
  "numberType": "FIXED_LINE_OR_MOBILE",
  "nationalSignificantNumber": "2128675309",
  "rawInput": "+1 212 867 5309",
  "isGeographical": true,
  "areaCode": "212",
  "location": "New York City (Manhattan)"
}

📘 Response Field Reference

🔢 Number Type Values

ℹ️ More Information

• Supports 240+ countries and territories
• Detects mobile vs. landline automatically
• Great for sign-up forms, CRMs, messaging tools, and more
• More details: GenderAPI Docs

📄 License

MIT License © GenderAPI