Name GET request
There are two APIs available for Name:
- /FIRSTNAMESUGGEST/: provides a list of first names based on the user's input.
Endpoint:
https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname={FIRST_NAME}&Gender={GENDER}&NBResponse={NUM}&Licence={LICENCE_CODE}&Country={COUNTRY_CODE}&Format={FORMAT}&Verifname=YReplace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code. | Mandatory |
| Firstname | {FIRST_NAME} |
Part of the first name already entered by the user. | Mandatory |
| Gender | {GENDER} |
M, F, or I. |
Optional |
| NBResponse | {NUM} |
Maximum number of suggestions to return. | Optional (default: 10) |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code used to prioritize suggestions. | Optional |
| Format | {FORMAT} |
Desired output format. | Optional (default: 0) |
| Verifname | Y |
Checks whether the first name exists without autocomplete. | Optional |
Format values:
| Format | Description |
|---|---|
0 |
First name in uppercase without accents. |
1 |
First letter uppercase without accents. |
2 |
First name in lowercase without accents. |
- /LASTNAMESUGGEST/: provides a list of last names based on the user's input.
Endpoint:
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname={NAME}&NBResponse={NUM}&Licence={LICENCE_CODE}Replace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code. | Mandatory |
| Lastname | {NAME} |
Part of the last name already entered by the user. | Mandatory |
| NBResponse | {NUM} |
Maximum number of suggestions to return. | Optional (default: 10) |
Related to