API - Description - Name - POST

Support DQE
Support DQE
  • Updated

Name POST request

There are two APIs available for Name:

  • /FIRSTNAMESUGGEST/: Provides a list of first names based on the user's input.

Header: https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/

The value {SERVER_ADDRESS} is the address of the DQE server that will process the data.
Simply add the parameters below in the Body to "x-www-form-urlencoded":

Parameter Expected value type Value description Mandatory/Optional
Licence {LICENCE_CODE} Number assigned to you as your license code Mandatory
Firstname {FIRST_NAME} Part of the first name already entered by the user Mandatory
Gender {GENDER} "M" or "F" or "I" Optional
NBResponse {NUM} Maximum number of suggestions to return Optional (by default: « 10 »)
Country {COUNTRY_CODE} ISO 3-letter country code to prioritize suggestions based on country Optional
Format {FORMAT} Desired output format Optional (by default: « 0 »)
Verifname Y Parameter to add if one wants to verify a first name without autocomplete. The returned list will return only one value if the first name is valid (and an empty list if the first name was not found in the database). Optional

The values to be returned in the "format" field are defined in the table below:

Values in « Format » Description
0 First name all in capital letters without accent
1 First letter of the name in capital letters without accent
2 First name all in lower case without accent
  • /LASTNAMESUGGEST/: Provides a list of last names based on the user's input

Header : https://{SERVER_ADDRESS}/LASTNAMESUGGEST/

The value {SERVER_ADDRESS} is the address of the DQE server that will process the data.
Simply add the parameters below in the Body to "x-www-form-urlencoded" :

Parameter Expected value type Value description Mandatory/Optional
Licence {LICENCE_CODE} Number assigned to you as your license code Mandatory
Lastname {NAME} Part of the name already entered by the user Mandatory
NBResponse {NUM} Maximum number of suggestions to return Optional (by default: « 10 »)

Related to

Was this article helpful?

0 out of 0 found this helpful