Skip to content

GiancarloJSantos/check-name

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

check-name

Simplest, cheapest and easiest API to check if there is a correct Brazillian first name in a string

Gif: Say my name

Introduction

If you are creating chatbots probably you have already asked the name of some user. For instance:

Bot: Hi there, what is your name?  
User: Rafael Pacheco  
Bot: Welcome, Rafael Pacheco. I'm very happy to talk with you.  

Result: 😀👍

Note that in this sample the Bot use the user input believing that it's a real and valid name. However, if the user sends something different than a name the result can be terrible, as shown below:

Bot: Hi there, what is your name?  
User: go F#%K yourself  
Bot: Welcome, go F#%K yourself. I'm very happy to talk with you.  

Result: 😔👎

This API was built in order to verify if there are correct Brazillian first names in a string.

How to use

Base URL for all endpoints https://check-name.herokuapp.com/

The response time will likely be a few seconds long on the first request, because this app is running on a free Heroku dyno. Subsequent requests will behave as normal.

Easiast way:

curl -i -X GET https://check-name.herokuapp.com/verify/Rafael%20Pacheco

If you need more details take a look the following links 👇

Endpoints

/verify Retrieve the analyze about some name.
/suggest Enable users to suggest any valid name not recognized by this API.


By the way, this project is based on the last Brazillian Censo (2010), there are more than 130,000 different first names of people in Brazil. The IBGE is the government institute responsible for this research. Click here if you want to get all the research database.

Note: This API should work for any valid Brazillian name of a person that has been born until 2010. However, if by some reason it doesn't work properly please submit the name using this endpoint.

Future work

  • Add support to names from other languages.
  • Add support to last names.
  • Suggest similar names.
  • Add names information about frequence rate, popularity, and rank.

About

Simplest, cheapest and easiest API to check if there are correct first names in a string

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%