| Type: | Package |
| Language: | en-US |
| Title: | Client for 'GenderAPI.io' Phone Number Validation and Formatter API |
| Version: | 1.0.1 |
| 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, Voice over Internet Protocol (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, Customer Relationship Management (CRM) data cleaning, and analytics tasks. Full documentation is available at https://www.genderapi.io/docs-phone-validation-formatter-api. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/GenderAPI/PhoneValidator-R |
| BugReports: | https://github.com/GenderAPI/PhoneValidator-R/issues |
| Imports: | httr, jsonlite |
| Depends: | R (≥ 3.5.0) |
| Encoding: | UTF-8 |
| Suggests: | spelling, testthat (≥ 3.0.0) |
| RoxygenNote: | 7.3.2 |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2025-09-02 10:01:45 UTC; onurozturk |
| Author: | Onur Ozturk [aut, cre] |
| Maintainer: | Onur Ozturk <onurozturk1980@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-09-08 18:40:28 UTC |
Validate Phone Number
Description
Sends a phone number to the GenderAPI.io Phone Validation & Formatter API to validate its structure, detect type (mobile, landline, Voice over Internet Protocol (VoIP)), retrieve region metadata, and format into standard formats. Visit (<https://www.genderapi.io>) to get free API KEY
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.