Introduction

Address IQ Realtime Services (AIQ Realtime Services for short) is a high-performance address validation webserver. It is powered by the Address IQ SDK and packaged in a PCI-compliant Docker image, and it auto-updates its monthly address directories for lights-out deployment.

You run the container inside your own infrastructure - on-premise or in your private cloud - and call its HTTP API to validate and standardize addresses in real time. This keeps sensitive customer data within your environment while giving you USPS CASS-grade address verification and high-accuracy geocoding.

At a high level, deploying AIQ Realtime Services involves three things:

1. The container image. The project is distributed as a Docker image (a .tar.gz archive) that you load and run with any PCI-compliant container tool.
2. The postal directories. Large reference data files containing address and geographic information. They live on a mounted volume outside the container and are installed and updated automatically using your Firstlogic credentials.
3. The HTTP API. Once the initial directory installation finishes, the container exposes a /validate-address endpoint that accepts a JSON address and returns a validated, enriched response.

• Pre-Deployment Considerations - hardware requirements and network rules to prepare before you install.
• Quickstart - load the image, run the container, and make your first request.
• Configuration - environment variables and YAML config for tuning behavior and output.
• API Reference - request/response format and every input and output field.