Package 'PhoneValidator'

Title: Client for 'GenderAPI.io' Phone Number Validation API
Description: Provides an interface to the 'GenderAPI.io' Phone Number Validation & Formatter API (<https://www.genderapi.io>) for validating international phone numbers, detecting number type (mobile, landline, VoIP), retrieving region and country metadata, and formatting numbers to E.164 or national format. Designed to simplify integration into R workflows for data validation, CRM data cleaning, and analytics tasks. Full documentation is available at <https://www.genderapi.io/docs-phone-validation-formatter-api>.
Authors: Onur Ozturk [aut, cre]
Maintainer: Onur Ozturk <[email protected]>
License: MIT + file LICENSE
Version: 1.0.0
Built: 2026-06-06 08:33:18 UTC
Source: https://github.com/genderapi/phonevalidator-r

Help Index


Validate Phone Number

Description

Sends a phone number to the GenderAPI.io Phone Validation & Formatter API to validate its structure, detect type (mobile, landline, VoIP), retrieve region metadata, and format into standard formats.

Usage

validate(api_key, number, address = "")

Arguments

api_key

Your GenderAPI.io API key as a Bearer token.

number

The phone number string to validate (in local or international format).

address

Optional. A free-form location string (e.g., city, country) to assist with parsing and validation.

Value

A list with phone number validation results including validity, formatting, region, and type information.