Trustfull

https://docs.trustfull.com/docs
Admin
Trustfull is a fraud prevention and identity risk intelligence platform that analyzes various...
Tokens:79,798
Snippets:458
Trust Score:8.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install JavaScript Snippet

Source: https://docs.trustfull.com/docs/integration-1

Paste this JavaScript code before your website's closing `</head>` tag. Replace YOUR-JS-KEY with your environment's ID.

```APIDOC
## Install JavaScript Snippet

### Description
To get started with Trustfull, paste the following JavaScript code before your website's closing `</head>` tag. When using this JS, remember to replace **YOUR-JS-KEY** with the ID of the environment to which you want to send data. You can find this ID on your dashboard.

### Method
Client-side JavaScript

### Endpoint
N/A (Embedded in website)

### Parameters
#### Global Variables
- **window.tfbd** (function) - The Trustfull bot detection function.

### Request Example
```html
<script>
   (function(f,i,d,o,c,od,e){f['FidoObject']=c;f[c]=f[c]||function(){
        (f[c].q=f[c].q||[]).push(arguments)}
        ,f[c].l=1*new Date();od=i.createElement(d),
        e=i.getElementsByTagName(d)[0];od.async=1;od.src=o;
        e.parentNode.insertBefore(od,e)
   })(window,document,'script', 'https://det.trustfull.com/det.js', 'tfbd');
        
   tfbd('create', 'YOUR_APP_KEY');
</script>
```

### Response
N/A (Client-side integration)
```

--------------------------------

### Install Trustfull JavaScript Snippet

Source: https://docs.trustfull.com/docs/integration-1

This snippet should be placed before the closing `</head>` tag of your HTML. Replace 'YOUR_JS_KEY' with your environment's ID. The SDK is always loaded over SSL.

```html
<script>
   (function(f,i,d,o,c,od,e){f['FidoObject']=c;f[c]=f[c]||function(){
        (f[c].q=f[c].q||[]).push(arguments)}
        ,f[c].l=1*new Date();od=i.createElement(d),
        e=i.getElementsByTagName(d)[0];od.async=1;od.src=o;
        e.parentNode.insertBefore(od,e)
   })(window,document,'script', 'https://det.trustfull.com/det.js', 'tfbd');
        
   tfbd('create', 'YOUR_APP_KEY');
</script>
```

--------------------------------

### List and Download Datasets using Python (boto3)

Source: https://docs.trustfull.com/docs/integration-2

Demonstrates how to use the boto3 library in Python to list objects in an S3 bucket under a specific customer prefix and download a file. Requires the 'boto3' library to be installed.

```python
import boto3

# Configure AWS access
aws_access_key = "your-access-key"
aws_secret_key = "your-secret-key"
bucket_name = "your-dataset-bucket"
customer_id = "123456"  # Your assigned customer ID

# Initialize S3 client
s3_client = boto3.client(
    "s3",
    aws_access_key_id=aws_access_key,
    aws_secret_access_key=aws_secret_key
)

# List files in the S3 bucket under the customer's prefix
prefix = f"{customer_id}/"
response = s3_client.list_objects_v2(Bucket=bucket_name, Prefix=prefix)

if "Contents" in response:
    print("Available datasets:")
    for obj in response["Contents"]:
        print(obj["Key"])

    # Download a specific file
    file_name = "dataset-file.csv"
    s3_client.download_file(bucket_name, f"{prefix}{file_name}", file_name)
    print(f"Downloaded {file_name}")

else:
    print("No files found in the bucket for this customer ID.")

```

--------------------------------

### Installing the Trustfull JavaScript Script

Source: https://docs.trustfull.com/docs/login

Include this JavaScript snippet on your login page to capture behavioral and device data during login attempts. Ensure you replace 'your-js-key' with your actual JS key.

```APIDOC
## Installing the Trustfull JavaScript Script

### Description
Include this JavaScript snippet on your login page to capture behavioral and device data during login attempts. This script collects activity-related data and associates it with a unique session ID. No sensitive user information is tracked.

### Key Points
* Captures behavioral and device data in real-time.
* Does not track passwords or sensitive user information.
* Requires a unique session ID for each login attempt, which must be securely stored.
* The username field must have the `data-tf="username"` attribute.

### Example of Including the JavaScript Script

```html
<script>
    (function (f, i, d, o, c, od, e) {
        f['FidoObject'] = c;
        f[c] = f[c] || function () {
            (f[c].q = f[c].q || []).push(arguments);
        }, f[c].l = 1 * new Date();
        od = i.createElement(d),
            e = i.getElementsByTagName(d)[0];
        od.async = 1;
        od.src = o;
        e.parentNode.insertBefore(od, e);
    })(window, document, 'script', 'https://login.trustfull.com/login.js', 'tf');

    tf('create', 'your-js-key');
</script>
```

### Important Notes
* Replace `'your-js-key'` with the JS key provided to you.
* Ensure the script is placed on the login page where user interactions will be monitored.
```

--------------------------------

### POST /1.0/hub (Onboarding - Bad Scenario)

Source: https://docs.trustfull.com/docs/api-sandbox

This example shows how to simulate a 'bad' onboarding scenario in the API Sandbox. Replace '[your_app_key]' with your actual API key.

```APIDOC
## POST /1.0/hub

### Description
Simulates a 'bad' onboarding scenario in the API Sandbox. This allows testing of the onboarding solution with a negative score simulation.

### Method
POST

### Endpoint
https://sandbox.trustfull.com/1.0/hub

### Parameters
#### Query Parameters
- **x-api-key** (string) - Required - Your active API key.

#### Request Body
- **customer_id** (string) - Required - Set to 'bad' to simulate a negative score.
- **claims** (array) - Required - List of claims to request, e.g., ["phone", "email", "name", "score"].
- **phone_number** (string) - Optional - Phone number for the simulation.
- **email** (string) - Optional - Email address for the simulation.
- **first_name** (string) - Optional - First name for the simulation.
- **last_name** (string) - Optional - Last name for the simulation.

### Request Example
```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data \
'{
     "customer_id": "bad",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "Tony",
     "last_name": "Stark"
}'
```

### Response
#### Success Response (200)
- **score** (number) - The simulated score.
- **claims_results** (object) - Results for the requested claims.
```

--------------------------------

### POST /1.0/hub (Onboarding - Good Scenario)

Source: https://docs.trustfull.com/docs/api-sandbox

This example demonstrates how to use the API Sandbox to simulate a 'good' onboarding scenario. Replace '[your_app_key]' with your actual API key.

```APIDOC
## POST /1.0/hub

### Description
Simulates a 'good' onboarding scenario in the API Sandbox. This allows testing of the onboarding solution with a positive score simulation.

### Method
POST

### Endpoint
https://sandbox.trustfull.com/1.0/hub

### Parameters
#### Query Parameters
- **x-api-key** (string) - Required - Your active API key.

#### Request Body
- **customer_id** (string) - Required - Set to 'good' to simulate a positive score.
- **claims** (array) - Required - List of claims to request, e.g., ["phone", "email", "name", "score"].
- **phone_number** (string) - Optional - Phone number for the simulation.
- **email** (string) - Optional - Email address for the simulation.
- **first_name** (string) - Optional - First name for the simulation.
- **last_name** (string) - Optional - Last name for the simulation.

### Request Example
```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data \
'{
     "customer_id": "good",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "Tony",
     "last_name": "Stark"
}'
```

### Response
#### Success Response (200)
- **score** (number) - The simulated score.
- **claims_results** (object) - Results for the requested claims.
```

--------------------------------

### Verify AWS CLI Installation

Source: https://docs.trustfull.com/docs/integration-2

Checks if the AWS Command Line Interface (CLI) is installed and displays its version. This is a prerequisite for interacting with AWS services like S3.

```bash
aws --version
```

--------------------------------

### Activate Sandbox Mode via Header

Source: https://docs.trustfull.com/docs/api-sandbox

This example shows how to activate the API Sandbox mode by setting a 'demo' header, even if you cannot change the production endpoint.

```APIDOC
## Activate Sandbox Mode via Header

### Description
This method allows you to activate the API Sandbox mode by including a specific header in your request, even if you are using the production endpoint URL. This is useful for testing purposes without altering the request URL.

### Method
POST (or any other applicable HTTP method for the endpoint)

### Endpoint
[Production Endpoint URL]

### Parameters
#### Query Parameters
- **demo** (integer) - Required - Set to `1` to activate sandbox mode.

### Request Example
```shell
curl --request POST \
     --url [Production Endpoint URL] \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --header 'demo: 1' \
     --data \
'[Your Request Payload]'
```

### Response
#### Success Response (200)
- The response will be from the sandbox environment, simulating API behavior.
```

--------------------------------

### POST /1.0/hub (Phone - Moderate Scenario)

Source: https://docs.trustfull.com/docs/api-sandbox

This example shows how to simulate a 'moderate' phone scenario in the API Sandbox. Replace '[your_app_key]' with your actual API key.

```APIDOC
## POST /1.0/hub

### Description
Simulates a 'moderate' phone scenario in the API Sandbox. This allows testing of phone number validation with a moderate score simulation.

### Method
POST

### Endpoint
https://sandbox.trustfull.com/1.0/hub

### Parameters
#### Query Parameters
- **x-api-key** (string) - Required - Your active API key.

#### Request Body
- **customer_id** (string) - Required - Set to 'moderate' to simulate a moderate score.
- **claims** (array) - Required - List of claims to request, must include "phone".
- **phone_number** (string) - Required - The phone number to simulate.

### Request Example
```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data \
'{
     "customer_id": "moderate",
     "claims": [
          "phone"
     ],
     "phone_number": "39349xxxxxxx"
}'
```

### Response
#### Success Response (200)
- **score** (number) - The simulated score.
- **claims_results** (object) - Results for the requested claims.
```

--------------------------------

### Configure AWS CLI Credentials

Source: https://docs.trustfull.com/docs/integration-2

Guides the user through configuring AWS CLI with access key ID, secret access key, default region, and output format. These credentials are required for authentication with AWS.

```bash
aws configure
```

--------------------------------

### Initialize Trustfull SDK with JS-KEY (HTML)

Source: https://docs.trustfull.com/docs/integration-1

This snippet demonstrates the correct way to initialize the Trustfull JavaScript SDK by including your unique JS-KEY. Ensure you are using the key provided after logging into your Trustfull account or from the developer documentation to avoid initialization errors.

```html
det("create", "YOUR-JS-KEY"); 

```

--------------------------------

### Retrieve Results (Server-To-Server API)

Source: https://docs.trustfull.com/docs/integration-1

Make a server-to-server API call using the session ID to obtain bot detection results after data processing.

```APIDOC
## Retrieve Results (Server-To-Server API)

### Description
Once the data is processed, a server-to-server API call will be performed using the session ID to obtain the detection results. The API response provides a score reflecting bot activity likelihood and the raw collected data.

### Method
GET

### Endpoint
`https://api.trustfull.com/bot-detection/result{YOUR_SESSION_ID}`

### Parameters
#### Path Parameters
- **YOUR_SESSION_ID** (string) - Required - The unique identifier for the session.

#### Headers
- **X-api-Key** (string) - Required - Your API key for authentication.
- **Content-Type** (string) - Required - Set to `application/json`.

### Request Example
```curl
curl -X GET "https://api.trustfull.com/bot-detection/result`{YOUR_SESSION_ID}`" \
     -H "X-api-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json"
```

### Response
#### Success Response (200)
- **score** (number) - The bot activity likelihood score.
- **rawData** (object) - The raw data collected during the session.

#### Response Example
```json
{
  "score": 0.85,
  "rawData": {
    "userAgent": "Mozilla/5.0 ...",
    "ipAddress": "192.168.1.1",
    "... other collected data ..."
  }
}
```
```

--------------------------------

### List Datasets in S3 Bucket (Unix/Windows)

Source: https://docs.trustfull.com/docs/integration-2

Lists all files and directories within a specified S3 bucket prefix, corresponding to a customer ID. Requires AWS CLI to be configured.

```shell
$ aws s3 ls s3://your-dataset-bucket/123456/
```

--------------------------------

### POST /1.0/track/enrollments

Source: https://docs.trustfull.com/docs/login

Creates a new enrollment for a user if one does not already exist. This is a crucial step for establishing a baseline of trusted behavior for subsequent login scoring.

```APIDOC
## POST /1.0/track/enrollments

### Description
Creates a new enrollment for a user. This endpoint should be called when no existing enrollment is found for the user.

### Method
POST

### Endpoint
`http://api.fido.id/1.0/track/enrollments`

### Parameters
#### Query Parameters
- **session_id** (string) - Required - The session ID associated with the login event.

#### Headers
- **x-api-key** (string) - Required - Your unique API key for authentication.

### Request Example
```http
POST http://api.fido.id/1.0/track/enrollments?session_id=<session-id>
x-api-key: <your-api-key>
```

### Response
#### Success Response (200)
(Response details not provided in the source text. Refer to external API documentation for specifics.)

#### Response Example
(Response example not provided in the source text.)
```

--------------------------------

### Download All Datasets (Unix/Windows)

Source: https://docs.trustfull.com/docs/integration-2

Synchronizes all datasets from a specified S3 bucket prefix to the local directory. This is useful for downloading the entire dataset for a customer ID. Requires AWS CLI to be configured.

```shell
$ aws s3 sync s3://your-dataset-bucket/123456/ .
```

--------------------------------

### Download Specific Dataset File (Unix/Windows)

Source: https://docs.trustfull.com/docs/integration-2

Downloads a single specified dataset file from an S3 bucket prefix to the local directory. Requires AWS CLI to be configured.

```shell
$ aws s3 cp s3://your-dataset-bucket/123456/dataset-file.csv .
```

--------------------------------

### GET /websites/trustfull

Source: https://docs.trustfull.com/docs/data-catalogue-ip

Retrieves detailed information about a given IP address, including company details, technology stack, and various trust and risk signals.

```APIDOC
## GET /websites/trustfull

### Description
Retrieves detailed information about a given IP address, including company details, technology stack, and various trust and risk signals.

### Method
GET

### Endpoint
/websites/trustfull

### Parameters
#### Query Parameters
- **ip** (string) - Required - The IP address to query.

#### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **ip_company_facebook_url** (string) - Provides the Facebook url of the company, links is always pointing to facebook domain.
- **ip_company_linkedin_url** (string) - Provides the Linkedin url of the company, links is always pointing to linkedin domain.
- **ip_company_total_funding** (integer) - Provides the total amount of funding raised by company.
- **ip_company_tech_stack** (string) - Indicates the set of technologies uses by the company.
- **ip_reason_codes** (string) - Comma separated risk and trust signal for the product ip.
- **ip_identity_device_count** (integer) - The number of devices associated with this ip address.
- **ip_identity_email_count** (integer) - The number of email addresses associated with this ip address.
- **ip_identity_msisdn_count** (integer) - The number of phones associated with this ip address.
- **ip_identity_name_count** (integer) - The number of names associated with this ip address.
- **ip_remote_desktop_enable** (boolean) - Indicates if the IP is enabled to accept connections from common remote desktop software.
- **ip_xbl_count** (integer) - The number of times this IP address has been reported in a Exploits Blocklist (XBL).
- **ip_css_count** (integer) - The number of times this IP address has been reported in a Combined Spam Sources (CSS).
- **ip_xbl_in_days** (integer) - The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.
- **ip_css_in_days** (integer) - The how many days has passed since the most recent report in a Combined Spam Source (CSS). Recency indicates more accurate data.
- **ip_is_valid_format** (boolean) - Indicates if the IP is in an accepted ipv4 or ipv6 format.
- **ip_is_private_internal_address** (boolean) - Indicates if the IP belongs to a private internal address.

#### Response Example
{
  "ip_company_facebook_url": "https://www.facebook.com/examplecompany",
  "ip_company_linkedin_url": "https://www.linkedin.com/company/examplecompany",
  "ip_company_total_funding": 10000000,
  "ip_company_tech_stack": "JavaScript, Python, AWS",
  "ip_reason_codes": "TP001,RP001",
  "ip_identity_device_count": 5,
  "ip_identity_email_count": 10,
  "ip_identity_msisdn_count": 3,
  "ip_identity_name_count": 7,
  "ip_remote_desktop_enable": false,
  "ip_xbl_count": 0,
  "ip_css_count": 1,
  "ip_xbl_in_days": 30,
  "ip_css_in_days": 5,
  "ip_is_valid_format": true,
  "ip_is_private_internal_address": false
}
```

--------------------------------

### Trigger Data Submission

Source: https://docs.trustfull.com/docs/integration-1

Call this function to submit collected data at any point during a user session.

```APIDOC
## Trigger Data Submission

### Description
When ready (e.g., after a user action), call the following function to submit the collected data. This function can be invoked at any time during the user session.

### Method
JavaScript Function Call

### Endpoint
N/A (Client-side function)

### Parameters
#### Function Arguments
- **sessionId** (string) - Required - A unique identifier for the user session.

### Request Example
```javascript
det.sendRecord(`{YOUR_SESSION_ID}`)
```

### Response
N/A (Client-side function)
```

--------------------------------

### GET /websites/trustfull

Source: https://docs.trustfull.com/docs/data-catalogue-domain

Retrieves comprehensive trust score and related metrics for a given website.

```APIDOC
## GET /websites/trustfull

### Description
Retrieves comprehensive trust score and related metrics for a given website. This endpoint provides insights into backlink profile, SEO performance, and privacy policy adherence.

### Method
GET

### Endpoint
/websites/trustfull

### Parameters
#### Query Parameters
- **domain** (string) - Required - The domain name of the website to analyze.

### Request Example
```
GET /websites/trustfull?domain=example.com
```

### Response
#### Success Response (200)
- **domain_backlinks_count_seo** (integer) - Total number of backlinks discovered by SEO tools.
- **domain_backlinks_referring_domains** (integer) - Number of unique domains that link to the analyzed domain.
- **domain_backlinks_referring_ips** (integer) - Total number of unique IP addresses from which backlinks originate.
- **domain_backlinks_score** (integer) - A general quality score of the backlink profile.
- **domain_semrush_score** (integer) - Proprietary domain authority, based on the quality, quantity, and influence of backlinks.
- **domain_backlinks_from_a** (integer) - Number of backlinks found in anchor text elements within regular content.
- **domain_backlinks_from_form** (integer) - Number of backlinks embedded in HTML form elements.
- **domain_backlinks_from_frame** (integer) - Number of backlinks found inside iframe or similar frame-based structures.
- **domain_backlinks_from_image** (integer) - Number of backlinks originating from image tags.
- **domain_privacy_policy_content_path** (string) - The S3 link to the privacy policy page content.
- **domain_terms_and_conditions_content_path** (string) - The S3 link to the terms and conditions page content.
- **domain_privacy_policy_found** (boolean) - A flag indicating whether the privacy policy has been found.
- **domain_privacy_policy_has_clear_language** (boolean) - A flag indicating whether the privacy policy document is written in clear, plain language.
- **domain_privacy_policy_specifies_company_identity** (boolean) - A flag indicating whether the privacy policy document clearly identifies the company.
- **domain_privacy_policy_specifies_contact_information** (boolean) - A flag indicating whether the privacy policy document specifies valid contact information.
- **domain_privacy_policy_specifies_data_collection** (boolean) - A flag indicating whether the privacy policy document specifies the types of data collected, the methods of collection, the purposes of processing, and the legal basis for that processing.
- **domain_privacy_policy_specifies_data_sharing** (boolean) - A flag indicating whether the privacy policy document clearly explains how and with which third parties user data is shared.
- **domain_privacy_policy_is_gdpr_compliant** (boolean) - A flag indicating whether the privacy policy document adheres to GDPR regulations.
- **domain_privacy_policy_has_data_controller** (boolean) - A flag indicating whether the privacy policy document identifies the data controller.
- **domain_privacy_policy_has_cookie_policy** (boolean) - A flag indicating whether the privacy policy document includes a specific cookie policy.
- **domain_privacy_policy_is_generic** (boolean) - A flag indicating whether the privacy policy document is too generic.
- **domain_privacy_policy_with_unrealistic_promises** (boolean) - A flag indicating whether the privacy policy document contains unrealistic or misleading claims.
- **domain_terms_and_conditions_found** (boolean) - A flag indicating whether the terms and conditions document has been found.
- **domain_terms_and_conditions_has_clear_language** (boolean) - A flag indicating whether the terms and conditions document is written in clear, plain language.

#### Response Example
```json
{
  "domain_backlinks_count_seo": 10,
  "domain_backlinks_referring_domains": 5,
  "domain_backlinks_referring_ips": 3,
  "domain_backlinks_score": 75,
  "domain_semrush_score": 60,
  "domain_backlinks_from_a": 12,
  "domain_backlinks_from_form": 2,
  "domain_backlinks_from_frame": 1,
  "domain_backlinks_from_image": 4,
  "domain_privacy_policy_content_path": "s3://bucket-name/path/to/privacy_policy.html",
  "domain_terms_and_conditions_content_path": "s3://bucket-name/path/to/terms_and_conditions.html",
  "domain_privacy_policy_found": true,
  "domain_privacy_policy_has_clear_language": true,
  "domain_privacy_policy_specifies_company_identity": true,
  "domain_privacy_policy_specifies_contact_information": true,
  "domain_privacy_policy_specifies_data_collection": true,
  "domain_privacy_policy_specifies_data_sharing": true,
  "domain_privacy_policy_is_gdpr_compliant": true,
  "domain_privacy_policy_has_data_controller": true,
  "domain_privacy_policy_has_cookie_policy": true,
  "domain_privacy_policy_is_generic": false,
  "domain_privacy_policy_with_unrealistic_promises": false,
  "domain_terms_and_conditions_found": true,
  "domain_terms_and_conditions_has_clear_language": true
}
```

#### Error Response (400)
- **error** (string) - Description of the error (e.g., "Domain parameter is required.")

#### Error Response Example
```json
{
  "error": "Domain parameter is required."
}
```
```

--------------------------------

### Separate API Call for Email Product

Source: https://docs.trustfull.com/docs/deprecation-timeline

This JSON example shows a separate API call dedicated to the 'email' product. This demonstrates the alternative mitigation strategy of splitting bundled product claims into individual API requests.

```json
{
  "customer_id":'...',
  "email": '...',
  "claims": [
     'email'
  ]
}
```

--------------------------------

### Simulate Onboarding API Response with 'BAD' Customer ID

Source: https://docs.trustfull.com/docs/api-sandbox

This example shows how to simulate an 'Onboarding' API response with a 'bad' customer ID in the Trustfull sandbox. It uses a cURL command with appropriate headers and a JSON payload, including specific claims and customer details.

```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '\
{
     "customer_id": "bad",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "Tony",
     "last_name": "Stark"
}'
```

--------------------------------

### Simulate API Response Without Explicit Customer ID

Source: https://docs.trustfull.com/docs/api-sandbox

This example shows how to simulate an API response in the Trustfull sandbox when the 'customer_id' is auto-generated. It uses other fields like 'first_name' and 'email' to specify the scenario, demonstrating flexibility in sandbox testing.

```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '\
{
     "customer_id": "your_real_autogenerated_customer_id",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "bad",
     "last_name": "bad"
}'
```

--------------------------------

### API Call with Score Claim

Source: https://docs.trustfull.com/docs/deprecation-timeline

This JSON example demonstrates a mitigated API call that includes the 'score' claim. This approach bundles multiple product claims into a single request, adhering to the new API requirements.

```json
{
  "customer_id":'...',
  "email": '...',
  "phone_number": '...',
  "claims": [
     'phone',
     'email',
     'score'
  ]
}
```

--------------------------------

### POST /1.0/hub (Simulate Scenario Without customer_id)

Source: https://docs.trustfull.com/docs/api-sandbox

This example demonstrates how to simulate a scenario in the API Sandbox when the 'customer_id' cannot be directly set. You can use fields like 'first_name' to trigger a specific simulation. Replace '[your_app_key]' with your actual API key.

```APIDOC
## POST /1.0/hub

### Description
Simulates a scenario in the API Sandbox by using fields other than 'customer_id' to trigger the simulation. This is useful when 'customer_id' is auto-generated. Here, 'first_name' is used to simulate a 'bad' scenario.

### Method
POST

### Endpoint
https://sandbox.trustfull.com/1.0/hub

### Parameters
#### Query Parameters
- **x-api-key** (string) - Required - Your active API key.

#### Request Body
- **customer_id** (string) - Required - Your real auto-generated customer ID.
- **claims** (array) - Required - List of claims to request.
- **phone_number** (string) - Optional - Phone number for the simulation.
- **email** (string) - Optional - Email address for the simulation.
- **first_name** (string) - Optional - Set to a value like 'bad' to simulate a specific scenario if 'customer_id' cannot be set.
- **last_name** (string) - Optional - Last name for the simulation.

### Request Example
```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data \
'{
     "customer_id": "your_real_autogenerated_customer_id",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "bad",
     "last_name": "bad"
}'
```

### Response
#### Success Response (200)
- **score** (number) - The simulated score.
- **claims_results** (object) - Results for the requested claims.
```

--------------------------------

### Separate API Call for Phone Product

Source: https://docs.trustfull.com/docs/deprecation-timeline

This JSON example illustrates making a separate API call specifically for the 'phone' product. This is one of the mitigation strategies for API calls that previously bundled multiple claims without a 'score'.

```json
{
  "customer_id":'...',
  "phone_number": '...',
  "claims": [
     'phone'
  ]
}
```

--------------------------------

### List Object Versions in S3

Source: https://docs.trustfull.com/docs/integration-2

Retrieves a list of all versions of a specific object (dataset file) within an S3 bucket. This is useful for understanding dataset history and identifying version IDs. Requires AWS CLI to be configured.

```bash
aws s3api list-object-versions --bucket your-dataset-bucket --prefix 123456/dataset.csv
```

--------------------------------

### Download Specific Dataset Version

Source: https://docs.trustfull.com/docs/integration-2

Downloads a specific version of a dataset file from an S3 bucket using its VersionId. This allows for retrieving historical data. Requires AWS CLI to be configured.

```bash
aws s3api get-object --bucket your-dataset-bucket --key 123456/dataset.csv --version-id yd9E3xaM8lF_Example1 dataset_old.csv
```

--------------------------------

### API Call Without Score Claim

Source: https://docs.trustfull.com/docs/deprecation-timeline

This JSON example shows an API call that includes multiple claims but omits the 'score' claim. Such calls will no longer be supported, requiring either the inclusion of 'score' or separate API calls for each product.

```json
{
  "customer_id":'...',
  "email": '...',
  "phone_number": '...',
  "claims": [
     'phone',
     'email'
  ]
}
```

--------------------------------

### Configure AWS Credentials

Source: https://docs.trustfull.com/docs/integration-2

This command displays the currently configured AWS credentials, including the access key ID, secret access key, region, and output format. It helps in troubleshooting 'Access Denied' errors by verifying credential validity and configuration.

```bash
aws configure list
```

--------------------------------

### Simulate Phone Score API Response with 'MODERATE' Customer ID

Source: https://docs.trustfull.com/docs/api-sandbox

This example demonstrates simulating a phone score response from the Trustfull API sandbox using a 'moderate' customer ID. The request specifies only the 'phone' claim and provides a phone number in the payload.

```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '\
{
     "customer_id": "moderate",
     "claims": [
          "phone"
     ],
     "phone_number": "39349xxxxxxx"
}'
```

--------------------------------

### Capturing Login Events with JavaScript

Source: https://docs.trustfull.com/docs/login

Use this JavaScript code to capture login events after including the Trustfull script. It sends the session ID and username to Trustfull for analysis. Ensure your login form has the ID 'login-form' and the username input has the 'data-tf="username"' attribute.

```APIDOC
## Capturing Login Events with JavaScript

### Description
This script captures login events by listening for the form submission. It extracts the username and a session ID, then sends this data to Trustfull using `tf.sendRecord`. This is a crucial step before attempting to score the login event via the API.

### Method
JavaScript Event Listener

### Usage
Place this script on your login page after the Trustfull JavaScript has been included.

### Code Example

```javascript
const form = document.getElementById("login-form");
form.addEventListener("submit", (ev) => {
    const username = document.querySelector('input[data-tf="username"]').value;
    if (!username) {
        // Cannot send login event without a username
        return;
    }

    const sessionId = getSessionId(); // Ensure session ID is generated and shared with the backend
    tf.sendRecord(sessionId, username);
});
```

### Notes
* **Form ID**: Assumes your login form has the ID `login-form`. Adjust if your form ID differs.
* **Username Field**: The username input must have the `data-tf="username"` attribute.
* **Session ID**: `getSessionId()` is a placeholder function. You must implement logic to generate and retrieve a unique session ID. This ID must also be shared with your backend for API calls.
```

--------------------------------

### POST /1.0/track/results - Get Login Score

Source: https://docs.trustfull.com/docs/login

This API endpoint is used by your backend to retrieve the authentication score for a login event. It requires a session ID and your API key for authentication. An enrollment must exist for the user before this endpoint can be successfully called.

```APIDOC
## POST /1.0/track/results - Get Login Score

### Description
This endpoint retrieves the authentication score for a specific login event. It requires a `session_id` that was previously sent via the Trustfull JavaScript. An enrollment for the user must exist prior to calling this endpoint. If no enrollment exists, a 400 error will be returned.

### Method
POST

### Endpoint
`http://api.fido.id/1.0/track/results`

### Query Parameters
* **session_id** (string) - Required - The unique session ID generated during the login attempt.

### Headers
* **x-api-key** (string) - Required - Your Trustfull API key (different from the JS key). This is a shared secret between your backend and Trustfull.

### Request Example

```http
POST http://api.fido.id/1.0/track/results?session_id=your-session-id
Host: api.fido.id
x-api-key: your-api-key
```

### Response
#### Success Response (200 OK)
Returns the authentication score and related data.
- **score** (number) - The calculated authentication score.
- **details** (object) - Additional details about the score.

#### Error Response (400 Bad Request)
* **message** (string) - "No enrollment found for this user."
  This indicates that an enrollment must be created before attempting to score a login event.
```

--------------------------------

### Call Trustfull API to Get Login Score

Source: https://docs.trustfull.com/docs/login

This HTTP request demonstrates how to call the Trustfull API to retrieve a login score. It requires a session ID and an API key, which is distinct from the JS key and should be kept secret on the backend. This endpoint is used to track results for a given session.

```http
POST http://api.fido.id/1.0/track/results?session_id=<session-id>
x-api-key: <your-api-key>
```

--------------------------------

### Retrieve Bot Detection Results via API

Source: https://docs.trustfull.com/docs/integration-1

Use this cURL command to make a GET request to the Trustfull API to retrieve bot detection results for a specific session ID. Replace 'YOUR_SESSION_ID' and 'YOUR_API_KEY' with your actual values. The response includes a bot activity score and raw data.

```curl
curl -X GET "https://api.trustfull.com/bot-detection/result`{YOUR_SESSION_ID}`" \
     -H "X-api-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json"
```

--------------------------------

### Simulate Onboarding API Response with 'GOOD' Customer ID

Source: https://docs.trustfull.com/docs/api-sandbox

This example demonstrates how to make a POST request to the Trustfull API sandbox to simulate an 'Onboarding' response with a 'good' customer ID. It includes necessary headers and a JSON payload with claims for phone, email, name, and score.

```shell
curl --request POST \
     --url https://sandbox.trustfull.com/1.0/hub \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '\
{
     "customer_id": "good",
     "claims": [
          "phone",
          "email",
          "name",
          "score"
     ],
     "phone_number": "39349xxxxxxx",
     "email": "t***@trustfull.com",
     "first_name": "Tony",
     "last_name": "Stark"
}'
```

--------------------------------

### Onboarding Solution Data Schema Reference

Source: https://docs.trustfull.com/docs/data-catalogue-onboarding

This section details the general data parameters available in the Trustfull Onboarding Solution API responses.

```APIDOC
## Data Schema Reference

This section contains a reference to a full list of parameters returned by Trustfull for the Onboarding Solution. You can use this data catalogue as a reference in interpreting fields provided in our API responses.

### General Data

| Name                | Description                                               |
| :------------------ | :-------------------------------------------------------- |
| customer_id         | Customer id provided during the API call                  |
| resolution_id       | Resolution id which identifies user document within TRUSTFULL. |
| device_request_time | The Date Time when the request was made                   |
```

--------------------------------

### GET /websites/trustfull/ip_info

Source: https://docs.trustfull.com/docs/data-catalogue-bot-detection

Retrieves detailed information about a given IP address. This includes geolocation, ISP, connection speed, and various threat intelligence indicators.

```APIDOC
## GET /websites/trustfull/ip_info

### Description
Retrieves detailed information about a given IP address. This includes geolocation, ISP, connection speed, and various threat intelligence indicators.

### Method
GET

### Endpoint
/websites/trustfull/ip_info

### Parameters
#### Query Parameters
- **ip** (string) - Required - The IP address to retrieve information for.

#### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **ip** (string) - IP address of the login event.
- **ip_black_list_count** (integer) - The number of providers that have flagged this IP as spam.
- **ip_city** (string) - City associated with the IP address.
- **ip_company_domain** (string) - The name of the domain of the company that owns the domain, if found.
- **ip_connection_speed** (string) - Internet connection speed associated to the ip address. Enum: company/T1, broadband/cable/fiber, mobile.
- **ip_connection_type** (string) - Usage type classification of ISP or company. Enum: Commercial, Content Delivery Network, Fixed Line, Mobile ISP, Reserved, University / College / School.
- **ip_country** (string) - Country name associated with the IP address.
- **ip_country_code** (string) - Country associated with the IP address, ISO 3166 alpha-2.
- **ip_css_count** (integer) - The number of times this IP address has been reported in a Combined Spam Sources (CSS).
- **ip_css_in_days** (integer) - The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.
- **ip_is_hosting** (boolean) - Indicates if the IP address is an hosting provider.
- **ip_is_mobile** (boolean) - Indicates if the IP address is associated with a mobile connection.
- **ip_isp** (string) - Internet service provider associated with the IP address.
- **ip_is_proxy** (boolean) - Indicates if the IP address is a proxy.
- **ip_is_relay** (boolean) - Indicates if the IP address is a relay.
- **ip_is_tor** (boolean) - Indicates if the IP address is part of the Tor network.
- **ip_is_valid_format** (boolean) - Indicates if the IP address is in a valid format.
- **ip_is_vpn** (boolean) - Indicates if the IP address is associated with a VPN.
- **ip_lat** (string) - Latitude of the location associated with the IP address.
- **ip_lon** (string) - Longitude of the location associated with the IP address.
- **ip_proxy_name** (string) - Name of the proxy associated with the IP address, if any.
- **ip_proxy_type** (string) - When the IP address is a Proxy, indicates the type of Proxy. Enum: datacenter, residential.
- **ip_timezone** (string) - The Timezone the IP address belongs to.
- **ip_timezone_request_time** (string) - Time of the day the user is requesting your service. Enum: morning, afternoon, evening, night.
- **ip_xbl_count** (integer) - The number of times this IP address has been reported in a Exploits Blocklist (XBL).
- **ip_xbl_in_days** (integer) - The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.
- **ip_zip** (string) - ZIP code associated with the IP address.
- **has_suspicious_browser_timezone_format** (boolean) - When browser returns a non IANA Timezone it usually indicates a non standard environment or a manipulated browser.
- **permissions_detected_browser_navigator_match** (boolean) - A flag indicating when the browser engine inferred from permissions matches with sessions metadata.
- **media_type_detected_browser_navigator_match** (boolean) - A flag indicating when the browser engine inferred from media type matches with sessions metadata.

#### Response Example
```json
{
  "ip": "192.168.0.1",
  "ip_black_list_count": 5,
  "ip_city": "New York",
  "ip_company_domain": "google.com",
  "ip_connection_speed": "broadband/cable/fiber",
  "ip_connection_type": "Commercial",
  "ip_country": "United States",
  "ip_country_code": "US",
  "ip_css_count": 3,
  "ip_css_in_days": 7,
  "ip_is_hosting": false,
  "ip_is_mobile": false,
  "ip_isp": "Comcast",
  "ip_is_proxy": false,
  "ip_is_relay": false,
  "ip_is_tor": false,
  "ip_is_valid_format": true,
  "ip_is_vpn": false,
  "ip_lat": "40.7128",
  "ip_lon": "-74.0060",
  "ip_proxy_name": null,
  "ip_proxy_type": null,
  "ip_timezone": "CET",
  "ip_timezone_request_time": "night",
  "ip_xbl_count": 2,
  "ip_xbl_in_days": 2,
  "ip_zip": "10001",
  "has_suspicious_browser_timezone_format": true,
  "permissions_detected_browser_navigator_match": true,
  "media_type_detected_browser_navigator_match": true
}
```
```
Tokens:
Raw