Postcode API

Address details for France

This page describes only country specific information for the address details response. See get address details documentation for an overview of the address details request and response in general.

France address "details" property example

{
    "language": "fr-FR",
    "address": {
        "country": "France",
        "locality": "Paris",
        "street": "Rue du Faubourg Saint-Honoré",
        "postcode": "75008",
        "building": "1",
        "buildingNumber": 1,
        "buildingNumberAddition": null
    },
    "mailLines": [
        "55 Rue du Faubourg Saint-Honoré",
        "75008 Paris"
    ],
    "location": {
        "latitude": 48.868394,
        "longitude": 2.32292
    },
    "country": {
        "name": "France",
        "iso3Code": "FRA"
    },
    "details": {
        "fraBuilding": {
            "number": 1,
            "addition": null,
            "validated": true
        },
        "fraStreet": {
            "name": "Rue du Faubourg Saint-Honoré"
        },
        "fraMunicipality": {
            "name": "Paris"
        }
    }
}

Response property "details" for country code "FRA"

fraBuilding: struct

French building details.

Hide child parameters
number: int or null

The number for the building.

addition: string or null

The number addition for the building if available, null otherwise.

validated: boolean

Indication whether the building could be validated. When true it means that the combination of building number and building number addition exists.

fraStreet: struct

French street details.

Hide child parameters
name: string

Name of the street

fraMunicipality: struct

French municipality details. (French commune)

Hide child parameters
name: string

Name of the municipality (commune).