Name

Trustfull'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 Trustfull name

What is Trustfull name?

Trustfull name is a product that combines advanced name validation, data enrichment, and a specific AI model all based on a single touch point, the name number.

Request

following an example of a Trustfull 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"
    ],
    "value": "John,Doe",
    "is_valid": true,
    "gender": "F",
    "score": 649,
    "score_cluster": "very_high",
    "risk_type": "HUMOROUS",
    "has_facebook": true,
    "facebook_avatar_url": "https://...",
    "reason_codes": "TP001,RP001",
    "identity_device_count": 2,
    "identity_email_count": 2,
    "identity_msisdn_count": 2,
    "identity_ip_count": 2
}

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
is_valid	boolean Determines whether the name is a valid first and last name Ex: true
gender	string The gender derived from the first and last name Ex: F Enum: F,M
score	integer 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 provided Ex: very_high Enum: 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: The invalid name might be the result of random or unintentional typing errors. PLACEHOLDER: An invalid name described as a placeholder typically means it's a common placeholder name such as John Doe PLACEHOLDER_TITLE: Similar to "PLACEHOLDER," but specifically indicating that the invalid name is intended as a title such as Mr or Miss. FICTIONAL: The invalid name is fictional or imaginary, not representing a real entity or person. FAMOUS: It closely resembles or is associated with a well-known person, place, or entity. HUMOROUS: The invalid name is possibly a joke word. INVALID: A general category indicating that the name is invalid without specifying the reason. INVALID_CHARACTERS: The invalid name contains characters that are not allowed or recognized. STRING_SIMILARITY: Values found in first_name and last_name are very similar to each other often the same identical string VULGAR: If the invalid name contains offensive or inappropriate language, it would be classified as "VULGAR." OTHER: This category is a catch-all for any other type of risk or issue not covered by the specific categories above. Ex: HUMOROUS Enum: RANDOM_TYPING, PLACEHOLDER, PLACEHOLDER_TITLE, FICTIONAL, FAMOUS, HUMOROUS, INVALID, STRING_SIMILARITY, OTHER, VULGAR, ...
has_facebook	boolean DEPRECATED* Indicates that the name of the user is present on facebook, without ambiguities Ex: true
facebook_avatar_url	string DEPRECATED* A url pointing to the facebook profile picture Ex: https://...
reason_codes	string Comma separated risk and trust signal for the product name. For more information about reason codes you can go to Reason Codes Ex: TP001,RP001
identity_device_count	integer The number of devices identities associated with this name Ex: 2
identity_email_count	integer The number of email identities associated with this name Ex: 2
identity_msisdn_count	integer The number of phones associated with this name Ex: 2
identity_ip_count	integer The number of ip addresses associated with this phone name Ex: 2