Address API - Introduction

Support DQE
Support DQE
  • Updated

A suite of endpoints for address suggestion and validation. Choose the integration path that matches your form design.

DQE offers two sets of API endpoints with equivalent functionality:

  • Legacy WS - the original WS-style endpoints, still fully supported.
  • RESTful - the newer REST endpoints, recommended for new integrations.

Which mode should I use?

  • Use Single mode for a simple address autocomplete experience with one input field.
  • Use Funnel mode when you want a guided address entry flow, usually postal code or city first, then street, then building or apartment complement.
  • Use RNVP / CheckAddress when the user has already entered a full address and you need to validate or correct it.
Before implementing - Read the Integration guide → It covers common patterns, edge cases and pitfalls that apply to all endpoints. Strongly recommended.
Prerequisite - The country field must be provided using the expected country code (three-letter ISO code).
Suggestion Choose one approach depending on your form design
Validation Secure all entry cases - call after free-text input or modified suggestion
CHECKADDRESS
/RNVP/ · REST: /checkaddress/
Restructures, validates and normalizes a complete address.
To check which countries and address features are supported, see Address Coverage →

Integration flows

Single mode - /SINGLEV2/ → /COMPLV2/
Single-line address autocomplete flow: SINGLEV2 then COMPLV2
Funnel mode - /CP/ → /ADR/ → /COMPL/
Funnel address autocomplete flow: CP, ADR, then COMPL
RNVP / CheckAddress - /RNVP/
RNVP address validation flow

 

Related to

Was this article helpful?

0 out of 0 found this helpful