API Restful - Description - Address - Check Address - GET

Support DQE
Support DQE
  • Updated

It is possible to check a complete address after entry in addition to or instead of auto-completion.
Control of a form (checkaddress call) outside of France: check address calls can also be used for international addresses but require a specific license with separate pricing (contact your account manager).

Header:
https://{SERVER_ADDRESS}/{VERSION}/checkaddress/?Address={INPUT}&Length={LENGTH}&Country={COUNTRY_CODE}&Suggestion={PROP}&Modification=O&Version={VERSION_JSON}&Licence={LICENCE_CODE}

Simply replace the items in braces with your information :

ParameterValue of the parameterValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Version{VERSION}

Version of the API

Example : v1

Mandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory
Address{INPUT}

Character string containing the recomposed address with the "|" character as separator (pipe) in the form: "additional address|address|dependent locality or state|zip code|city ".

The pipes are mandatory even if the values are empty.

Mandatory
Country{COUNTRY_CODE}ISO country code (3 letters)Mandatory
Length{LENGTH}Character limit for the « Address » response field

Optional (if not specified, default is 38)

Advice minimum value : 32

Suggestion{PROP}

France only.

Allows for multiple correction options instead of one

  • Value "O": In this case the JSON response contains several records numbered from 1 to n instead of one.
  • Value "S": In this cas the json answer will include a suggestion in case of Modification=O
Optional
ModificationOAllows you to know which field of the address (additional address|address|dependent locality|zip code|city) has been adjusted by the RNVPOptional
Version{VERSION_JSON}

1.1 : Allows you to indicate the nature of the geocoding on the address (if subscribed) (France Only)

2 : Get the list of additional address information in a specific field "ListeComplement"

Optional
Segmentation{Segmentation}

Add information about Finesis if the value is equal to "O" :

Sprofil : Profil of the population

Sportrait : Protrait of the population

Ssegment : Segmentation of the population

Optional

If not specified it is equal to N

 

Related to

Was this article helpful?

0 out of 0 found this helpful