API CityDate — Localité de naissance par code postal

Support DQE
Support DQE
  • Mise à jour

L'endpoint CPFRA valide si une ville ou une localité existait et était valide pour une date de naissance donnée.

Documentation CityDate associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/CPFRA/?DDN={BIRTHDATE}&INSEE={INSEE_CODE}&CP={POSTAL_CODE}&Localite={CITY_NAME}&Licence={LICENCE_CODE}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
Licence {LICENCE_CODE} Code de licence. Obligatoire
DDN {BIRTHDATE} Date de naissance au format YYYY-MM-DD. Obligatoire
INSEE {INSEE_CODE} Code INSEE. L'un des champs INSEE, CP ou Localite est obligatoire.
CP {POSTAL_CODE} Code postal. L'un des champs INSEE, CP ou Localite est obligatoire.
Localite {CITY_NAME} Nom de la ville. L'un des champs INSEE, CP ou Localite est obligatoire.

Requête POST

Endpoint

https://{SERVER_ADDRESS}/CPFRA/

Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence. Obligatoire
DDN {BIRTHDATE} Date de naissance au format YYYY-MM-DD. Obligatoire
INSEE {INSEE_CODE} Code INSEE. L'un des champs INSEE, CP ou Localite est obligatoire.
CP {POSTAL_CODE} Code postal. L'un des champs INSEE, CP ou Localite est obligatoire.
Localite {CITY_NAME} Nom de la ville. L'un des champs INSEE, CP ou Localite est obligatoire.

Réponse

Réponse de succès

Clé Valeurs possibles Description Type
Insee 75113 Code INSEE de la ville. STRING(10)
Localite Paris Nom de la ville. STRING(50)
Pays FR Code pays ISO 2. STRING(2)
CodePostal 75013 Code postal de la ville. STRING(10)
Status OK / KO Indique si la ville est valide pour la date de naissance donnée. STRING(2)

Exemple :

{
  "1": {
    "Localite": "EVRY",
    "Pays": "FR",
    "Insee": "89162",
    "CodePostal": "89140",
    "Status": "OK"
  },
  "3": {
    "Localite": "EVRY",
    "Pays": "FR",
    "Insee": "91228",
    "CodePostal": "91080",
    "Status": "KO"
  },
  "2": {
    "Localite": "EVRY",
    "Pays": "FR",
    "Insee": "91228",
    "CodePostal": "91000",
    "Status": "KO"
  }
}

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0