API - Description - Address - COMPLV2 - Response

This page describes the JSON response returned by the /COMPLV2/ endpoint.

Related Address documentation:

• Address API overview
• COMPLV2 GET request
• COMPLV2 POST request
• Address Swagger documentation

COMPLV2 success response

The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains additional address information for the selected street number.

Example requests

• https://{SERVER_ADDRESS}/COMPLV2/?IDVoie=1456244&IDNum=22&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
• https://{SERVER_ADDRESS}/COMPLV2/?IDVoie=1751437&IDNum=23&Taille=38&Pays=FRA&Licence={LICENCE_CODE}
• https://{SERVER_ADDRESS}/COMPLV2/?IDVoie=1357366&IDNum=116&Taille=38&Pays=FRA&Licence={LICENCE_CODE}

Additional fields

If your licence includes this option (France only), the following additional fields are returned:

Examples

Example without optional fields:

{
  "1": {
    "Batiment": "CHRISTY VIENER, FL 4",
    "CodePostal": "10020-2400"
  },
  "2": {
    "Batiment": "FL 4",
    "CodePostal": "10020-2402"
  },
  "Latitude": "40.758224999999996",
  "Longitude": "-73.977428"
}

Example with optional fields:

{
  "1": {
    "Batiment": "BATIMENT A"
  },
  "2": {
    "Batiment": "BATIMENT B"
  },
  "iris": "5101",
  "ilot": "1330015",
  "Longitude": "2.36184219788525",
  "Latitude": "48.8190056386452",
  "Status_IrisIlot": "INSEE"
}

COMPLV2 error response