Fido Name

Fido's API endpoints are quite flexible and you can request a range of services from a single endpoint

One of the possible use cases is Fido Name

What is Fido Name?

Fido Name is a product that combines advanced name validation, data enrichment, and a specific AI model all based on the first name and last name.

Request

following an example of a Fido Name

curl --request POST \
     --url https://api.fido.id/1.0/name \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '
{
     "customer_id": "c426ad68-8987-11ec-a8a3-0242ac120002",
     "claims": [
          "name"
     ],
     "first_name": "john",
     "last_name": "doe"
}'

Response

Following an example of the response:

{
   "resolution_id":"...",
   "customer_id":"...",
   "device_request_time":"...",
   "webhook_url": "...",
   "claims":[
      "name"
   ],
   "name":{
      "value":"John,Doe",
      "gender":"M",
      "is_valid":true,
      "risk_type":"PLACEHOLDER"
      "score": 649,
      "score_cluster": "high"
   }
}

RESPONSE

The following fields can be found under the "name" object

name	type
value	string the full name provided during the API call the comma separates the first name from the last name. ex: "John,Doe"
gender	string the gender derived from the name ex: M/F
is_valid	boolean determines whether the name is valid
score	int A number ranging from 0 to 1000 represents the quality of the name information detected ex: 649
score_cluster	string A cluster summarizing the quality of the name information detected ex: very_low, low, review, high, very_high
risk_type	?string If the name is not valid describes the type of risk possible values are: RANDOM_TYPING PLACEHOLDER PLACEHOLDER_TITLE FICTIONAL FAMOUS HUMOROUS INVALID STRING_SIMILARITY OTHER