Trustfull Domain
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Trustfull Domain checks whether a domain belongs to a real, operating business by analyzing its website, technical setup, company data and reputation, and returns a 0–1000 risk score.
Request
The Domain Intelligence endpoint works asynchronously. When you submit a request,
the API immediately responds with a 200 OK status if the request is valid and accepted for processing. The actual enrichment and decoration of the domain data happen in the background.
You can also send model_id to choose the model that computes the score. Use one of your custom models, or a Trustfull standard model such as domain_score. Without it, the API uses the active model.
Below is an example of a Trustfull Domain request:
curl --request POST \
--url https://api.fido.id/1.0/domain-intelligence/ \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-api-key: [your_app_key]' \
--data '
{
"customer_id": "your_customer_id",
"claims": [
"domain"
],
"domain": {
"value": "trustfull.com"
},
"model_id": "your_model_id"
}'Asynchronous Decoration
When you submit a request, the API immediately responds with a 200 OK status if the request is valid and accepted for processing. The actual enrichment and decoration of the domain data happen in the background.
To retrieve the result of the decoration, you must perform a subsequent call to the
dedicated API endpoint described at Get Domain API, using the customer_id provided in your original request.
Status Codes
| Code | Type | Description |
|---|---|---|
| 2XX | - | The request was successfully executed and the operation was successful |
| 400 | CLIENT | The request was not processed because it contained formal errors. The service will provide as a response the details of the detected error. These errors can range from invalid payload to logic errors in the API call. |
| 403 | CLIENT | The request was not processed because there was an issue with the authentication |
| 401 | CLIENT | This may happen if you correctly populated the API key field but the key is either incorrect or not enabled. |
| 402 | CLIENT | API key used has no available credit |
| 429 | CLIENT | Indicates the user has sent too many requests in a given amount of time |
| 500 | SERVER | This is a generic error indicating a server-side problem. |
| 504 | SERVER | Gateway timeout, the server took too much time to response and closed the connection. In most cases is safe to retry this kind of transaction |
Specific errors
All the errors listed below can be generated by calling the API with an invalid payload. These errors are classified as CLIENT ERRORS and will return a 400 status code.
When the API receives an invalid payload, it will respond with a 400 status code, indicating a client error. This occurs when the request parameters do not meet the required specifications or contain malformed data.
| Error | Description |
|---|---|
| INVALID_PAYLOAD | The payload of the request contains fields that are not managed by the API or misses some required fields. |
| DUPLICATED_CUSTOMER_ID | The request was performed with the same customer_id of a previous one. Only a single request is allowed for a customer_id. |