This page describes the CityDate POST endpoints used to retrieve place-of-birth locality information.
Related CityDate documentation:
CityDate POST request
CPFRA endpoint
Endpoint:
https://{SERVER_ADDRESS}/CPFRA/Add the following parameters in the request body using x-www-form-urlencoded.
| 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 POST request
The BirthLocality endpoint retrieves information about a French locality at a given date.
Endpoint:
https://{SERVER_ADDRESS}/BirthLocality/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| 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