Overview
The Byteplant Phone Validator node validates phone numbers using the Byteplant Phone Validator API. It is designed to verify whether a given phone number is valid, optionally considering country code and locale for more accurate validation and geocoding. This node is useful in scenarios where you need to ensure the correctness of user-provided phone numbers before processing them further, such as in customer onboarding, contact management, or fraud prevention workflows.
For example, you can use this node to:
- Validate phone numbers entered in a web form to reduce invalid contacts.
- Enrich contact data with geolocation information based on the phone number.
- Filter out invalid or suspicious phone numbers from marketing lists.
Properties
| Name | Meaning |
|---|---|
| Phone Number | The phone number string to validate. |
| Country Code | Optional two-letter ISO 3166-1 country code to help localize the validation. |
| Locale | IETF language tag (e.g., "en-US") used for geocoding and localization of results. |
| Mode | Validation mode: - Extensive: Performs a detailed validation. - Express: Performs a faster, less detailed validation. |
| Timeout | Timeout in seconds for the API request (minimum 5s, maximum 300s, default 10s). |
Output
The node outputs an array of items, each containing a json object with the validation result for the corresponding input item. The JSON structure includes:
status: The status of the validation request (e.g., success or specific error codes).- Additional fields returned by the Byteplant API, which typically include details about the phone number validity, formatting, location, carrier, and other metadata.
If the API key is invalid or depleted, the node throws an error indicating this issue.
No binary data output is produced by this node.
Dependencies
- Requires an active API key credential for the Byteplant Phone Validator API.
- The node makes HTTP GET requests to
https://api.phone-validator.net/api/v2/verify. - Requires network access to the Byteplant API endpoint.
- The node uses n8n's built-in authentication helper to securely handle the API key.
Troubleshooting
- API Key Invalid or Depleted: If the API key is invalid or has no remaining quota, the node will throw an error stating "API Key Invalid or Depleted". To resolve, verify your API key and ensure it has sufficient quota.
- Timeout Issues: Setting the timeout too low (below 5 seconds) may cause premature request failures. Adjust the timeout property within the allowed range (5-300 seconds).
- Invalid Phone Number Format: Ensure the phone number and country code are correctly formatted according to international standards to improve validation accuracy.
- Network Connectivity: Make sure the n8n instance has internet access to reach the Byteplant API endpoint.