Overview
The Byteplant Address Validator node validates postal addresses using the Byteplant Address Validator API. It verifies and standardizes address components such as street, city, postal code, state, and country code. The node can optionally enable geocoding to provide geographic coordinates for the address.
This node is useful in scenarios where accurate and standardized address data is critical, such as e-commerce shipping validation, customer data cleansing, or location-based services. For example, an online store can use this node to verify customer shipping addresses before dispatching orders, reducing delivery errors and returns.
Properties
| Name | Meaning |
|---|---|
| Country Code | Two-letter ISO 3166-1 country code (required) |
| Street Address | Main street address line (required) |
| City | City name |
| Additional Address Info | Additional address details like apartment or suite number |
| Postal Code | Zip or postal code |
| State | State or province |
| Geocoding | Boolean flag to enable or disable geocoding |
| Street Number | House number or building number; can be part of Street Address or provided separately |
| Locale | IETF language tag specifying preferred language for output; some countries support only English/local language |
| Output Charset | Character set for output; options are us-ascii or utf-8 |
| Timeout | Request timeout in seconds; default 10s, minimum 5s, maximum 300s |
Output
The node outputs a JSON object with the following structure:
status: Status string returned by the API indicating success or error.- Other fields: Various address validation results and metadata as returned by the Byteplant API, including standardized address components and optionally geocoding information if enabled.
If geocoding is enabled, the output may include latitude and longitude coordinates corresponding to the validated address.
Dependencies
- Requires an API key credential for the Byteplant Address Validator API.
- Makes HTTP GET requests to
https://api.address-validator.net/api/verify. - The node uses n8n's built-in request helper with authentication to communicate with the external API.
Troubleshooting
- API Key Invalid or Depleted: If the API key is invalid or has no remaining quota, the node throws an error "API Key Invalid or Depleted". To resolve, verify the API key validity and quota on the Byteplant service dashboard.
- Timeouts: Requests have a configurable timeout (default 10 seconds). Increase the timeout if network latency causes frequent timeouts.
- Invalid Input Data: Required fields like Country Code and Street Address must be provided; missing these will likely cause API errors.
- Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, appending error details to the output.