Introduction

The Address IQ SDK embeds the Address IQ engine directly in your application through a configuration-driven API with C++, Java, and .NET bindings.

Overview

The Address IQ SDK (the Address IQ API, or AIQ API) lets you build address validation, correction, and geocoding directly into your own software. Rather than running a batch job or calling a hosted service, you link the engine into your application and process records in-process, on your own terms.

The SDK is configuration-driven: you describe what you want the engine to do — which country, which processing options, which output fields — in a JSON or XML configuration, then feed records in and read structured results back. The same configuration concepts apply across every supported language.

Note: The Address IQ SDK is a module of Workflow IQ, Firstlogic's family of embeddable SDK modules.

What it does

  • Validate & correct — CASS-compliant U.S. address processing, plus Canadian address processing, with standardization and correction.
  • Certify & enhance — DPV, LACSLink, SuiteLink, RDI, eLOT, EWS, and DSF2.
  • Move update — NCOALink processing through the integrated Mover IQ engine.
  • Geocode — append latitude/longitude and census codes at address or centroid precision.
  • Process flexibly — accept discrete, hybrid, or multiline input and return richly structured JSON or XML output.

Supported languages

The SDK ships with bindings for C++, Java, and .NET. Each language has its own installation subfolder containing native documentation and runnable code samples, so you can start from working examples in your language of choice.

Note: The authoritative, always-current API surface (classes, methods, and the full output-field list) lives in the language-specific HTML documentation and the JSON/XML examples that ship with your installation. This documentation set covers the concepts, configuration, and result codes that are common across all languages.

Choosing the right product

The SDK shares the same underlying engine as the rest of the Address IQ family, but is delivered differently. Choose based on how you want to integrate:

  • Address IQ SDK (this documentation) — embed the engine in your own application and call it in-process. Best when you need tight integration and full control over the data flow.
  • AIQ Realtime Services — a containerized webserver you call over HTTP for real-time validation.
  • Address IQ — the standalone batch product for processing whole files and databases.
Note: These products are versioned and released independently, so refer to each product's own documentation for its capabilities and current version.

Next steps

PreviousIntroductionNext Installation & Setup