Configuration

There are some optional configurations you can use to customise the response.

All configuration options can be specified under an options object in the request body, as discussed in the introduction

JSON
POST  https://api.naurt.net/final-destination/v2
Content-Type: application/json
Authorization: <API_KEY_HERE>
{
    "queries": [RequestFormat],
    "options": Option<Options>
}

Where the Options itself is

JSON
{
  "structured_response": Optional<boolean>
}

Structured Response

Structured response will return the address in a parsed format as well as the concatenated string. To make a request with this option, set structured_response in the options object to true. For example, the request could be

JSON
{
  "queries": [
    {
      "address_string": "99 Rue de Clignancourt, 75018 Paris"
    }
  ],
  "options": {
    "structured_response": true
  }
}

And the response would be (reply condensed for readability)

{
  "request_id": "a193694f-490f-4990-9f94-61e9e1160362",
  "responses": [
    {
      "additional_matches": [],
      "best_match": {
        "address": "99 Rue de Clignancourt, 75018 Paris 18e Arrondissement, France",
        "geojson": {
          "features": [
            {
              "geometry": {
                "coordinates": [],
                "type": "Point"
              },
              "properties": {
                "naurt_type": "basic_geocode"
              },
              "type": "Feature"
            },
            {
              "geometry": {
                "coordinates": [],
                "type": "MultiPoint"
              },
              "properties": {
                "accuracy": {
                  "quality": "high"
                },
                "naurt_type": "naurt_door"
              },
              "type": "Feature"
            },
            {
              "geometry": {
                "coordinates": [],
                "type": "Polygon"
              },
              "properties": {
                "contributors": [
                  "Centre Scientifique et Technique du Batiment, National Buildings Database, 10 March 2025. This does not constitute an endorsement by Centre Scientifique et Technique du Batiment of this product"
                ],
                "naurt_type": "naurt_building"
              },
              "type": "Feature"
            },
            {
              "geometry": {
                "coordinates": [],
                "type": "Polygon"
              },
              "properties": {
                "accuracy": {
                  "quality": "high"
                },
                "minimum_parking_to_door_distance": 7.67,
                "naurt_type": "naurt_parking"
              },
              "type": "Feature"
            }
          ],
          "properties": {
            "contributors": [
              "data.gouv.fr, Base Adresse Nationale (BAN), 27 May 2025. This does not constitute an endorsement by data.gouv.fr of this product"
            ]
          },
          "type": "FeatureCollection"
        },
        "id": "3eaab5ff-14c6-36c8-a61f-535598ee00e5",
        "structured_response": {
          "city": "Paris 18e Arrondissement",
          "country": "France",
          "postalcode": "75018",
          "street_name": "Rue de Clignancourt",
          "street_number": "99"
        }
      },
      "status": "ok"
    }
  ],
  "version": "v2.1.0"
}

We can see the format of the structured response actually mirrors the format of the structured request, which is

{
    "address_line": Option<String>,
    "unit": Option<String>,
    "house_name": Option<String>,
    "street_number": Option<String>,
    "street_name": Option<String>,
    "city": Option<String>,
    "county": Option<String>,
    "state": Option<String>,
    "country": Option<String>,
    "postalcode": Option<String>
}