API - Description - Address - Introduction

Address API overview

The DQE Address API helps users enter, validate, complete and correct postal addresses in real time.

Address services can be used in different modes depending on your integration use case:

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.
• Use Address Coverage to understand which countries, quality levels and address features are available.

Related Address documentation

• Single mode documentation
• Funnel mode documentation
• CheckAddress / RNVP documentation
• Address Coverage
• Address Swagger documentation

Prerequisite

The country field must be provided using the expected country code. Some Address endpoints require the country to return accurate suggestions or validation results.

Single mode

Single mode provides address suggestions based on address text entered by the user in one input field.

• /SINGLEV2/: returns a list of suggestions including address, postal code, city and region.
• /COMPLV2/: returns a list of buildings or apartments based on a previously selected address, depending on the country.

Funnel mode

Funnel mode retrieves a complete address by filling in fields step by step.

• /CP/: returns a list of postal codes or cities.
• /ADR/: returns a list of addresses based on the selected postal code or city.
• /COMPL/: returns a list of buildings or apartments based on a previously selected address, depending on the country.

RNVP / CheckAddress mode

RNVP / CheckAddress mode validates a completed address and suggests a corrected version when the input address is invalid.

• /RNVP/: validates the address and returns a corrected address when applicable.