API User Guide
for Developers
The API User Guide is a comprehensive interactive document detailing how to integrate with IQ Office.
Built for easy integration
The API documentation is written for developers who want to get an integration up and running quickly and fine-tune for optimisation when ready.
Straightforward to use
Plain explanations and examples you can copy into your own code.
Comprehensive and up to date
The described services are detailed and match the API.
Error handling guidance
What each error means and how to handle it.
How the guide is organised
Two halves: the essentials to learn the service, and the references you’ll keep open while you build.
Service essentials
Getting started
A step-by-step introduction so developers can onboard quickly.
Fundamental methods
The primary functionality of the service and the advanced options available.
Use case demonstrations
Practical examples of the service solving common business problems in entity validation.
Service references
Data formats
Address records, custom properties, and the validation grammars for email and phone numbers.
ARFs and geographic codes
The address reference files and the geographic codes that correspond to them.
API reference
Request formats, query parameters and responses for each API, with web-based testing.
Get going fast!
Clear enough for a first integration, thorough enough for production.
Fast onboarding
A getting-started path that takes you from access to your first validated address with minimal setup.
A built-in test harness
Try requests in the browser, check the results you get back, and test changes before they reach production.
Core and advanced options
The primary methods you'll use every day, plus the advanced options for when your use case needs more control.
Ready to start building?
The full guide, test harness and API reference are in one place.