This page describes the CityDate GET endpoints used to retrieve place-of-birth locality information.
Related CityDate documentation:
CityDate GET request
CPFRA endpoint
Endpoint:
https://{SERVER_ADDRESS}/CPFRA/?DDN={BIRTHDATE}&INSEE={INSEE_CODE}&CP={POSTAL_CODE}&Localite={CITY_NAME}&Licence={LICENCE_CODE}Replace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code. | Mandatory |
| DDN | {BIRTHDATE} |
Birthdate in YYYY-MM-DD format. |
Mandatory |
| INSEE | {INSEE_CODE} |
INSEE code. | One of INSEE, CP, or Localite is mandatory. |
| CP | {POSTAL_CODE} |
Postal code. | One of INSEE, CP, or Localite is mandatory. |
| Localite | {CITY_NAME} |
City name. | One of INSEE, CP, or Localite is mandatory. |
BirthLocality GET request
The BirthLocality endpoint retrieves information about a French locality at a given date.
Endpoint:
https://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}Replace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Address of the DQE server that will process the data. | Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| BirthDate | {DATE} |
Date in YYYY-MM-DD format. |
Mandatory |
| Search | {LOOKUP} |
Search field using locality label, postal code or INSEE code. | Mandatory |
| NbMax | {NB_MAX} |
Maximum number of results returned by the API. | Optional. Default value: 20. |
Related to