Trustfull Hub
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Trustfull Hub checks a user's email, phone and IP together, finds whether they belong to the same real person, and returns one 0–1000 risk score.
Request
model_id is mandatory. It sets the model that computes the score: one of your custom models, or a Trustfull system model. The Standard Models page lists the ids of the system models.
Below is an example of a Trustfull Hub request with the claim "score":
curl --request POST \
--url https://api.fido.id/1.0/hub \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-api-key: [your_app_key]' \
--data '
{
"customer_id": "your_customer_id",
"claims": [
"phone",
"email",
"name",
"score"
],
"phone_number": "39349xxxxxxx",
"email": "t***@trustfull.com",
"first_name": "Tony",
"last_name": "Stark",
"model_id": "your_model_id"
}'
Mandatory fieldsField can become mandatory depending on the provided claim.
When providing a set of claims the Trustfull product API will perform validation on multiple fields, depending on the request.
Claim Score requirementsThe claim "score" works only when the request includes at least two other products
AVAILABLE CLAIMS
Claims are a way to request a combination of products:
| Claim | Description |
|---|---|
| phone | Enable Phone Number Intelligence |
| Enable Email Address Analytics | |
| name | Enable Name |
| ip | Enable IP Address Data |
| score | Enable the Hub score |
Response
Following an example of the response:
{
"resolution_id": "...",
"customer_id": "...",
"model_id": "...",
"device_request_time": "...",
"claims": [
"phone",
"email",
"name",
"ip",
],
"phone": {
...
},
"email": {
...
},
"ip": {
...
},
"score":{
"score": 735,
"score_cluster": "high",
"reason_codes": "RC001,TC002,TP002"
}
}
The "score" block is specific for the claim "score".
While all other products will still produce a specific score this block will display a score build using a model that takes into account all singles modules.
It's more than just a sum of the individual scores as it takes into account cross-product signals, and it's trained.
| name | type |
|---|---|
| score | int A number ranging from 0 to 1000 ex: 649 |
| score_cluster | string A cluster summarizing the score above. ex: very_low, low, review, high, very_high |
| reason_codes | string Coma separated risk and trust signal for all the products. ex: RC001,TC002,TP002 For more information about reason codes you can go to Reason Codes |
For a full description of the fields you can look at the individual products:
FAQ
Why the score is not an average of all the single scores I can find in the products?The Hub score found under the "score" block is much more than a mathematical average of individual products score.
It takes into account "cross-product" digital signals that might indicate consistency (or inconsistency) between multiple products.
While individual product can produce a positive score strong inconsistency between product can be a solid indicator of a synthetic identity.
What happens if I don't specify the claim "score" in the hub request?The request is valid even without the claim "score". If you don't provide the claim "score" the Hub score is not computed, and you will receive
only raw data and single product scores without the global identity score.
What happens if I pass the same customer_id on multiple requests?The customer_id is needed for the identity resolution. You must provide a different customer_id for each request.
If the same customer_id is used twice you will receive a 400 error
Why did I get a 401 "Unauthorized" response?This may happen if you correctly populated the API key field but the key is either incorrect or not enabled.