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 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:
Ex: HUMOROUS Enum: RANDOM_TYPING, PLACEHOLDER, PLACEHOLDER_TITLE, FICTIONAL, FAMOUS, HUMOROUS, INVALID, STRING_SIMILARITY, OTHER, VULGAR, ... |
has_facebook | boolean
Ex: true |
facebook_avatar_url | string
Ex: https://... |
reason_codes | string Comma separated risk and trust signal for the product name. 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 |